github.com/jghiloni/cli@v6.28.1-0.20170628223758-0ce05fe032a2+incompatible/command/flag/arguments.go (about)

     1  package flag
     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 CreateUser struct {
    89  	Username string  `positional-arg-name:"USERNAME" required:"true" description:"The username"`
    90  	Password *string `positional-arg-name:"PASSWORD" description:"The password"`
    91  }
    92  
    93  type AppInstance struct {
    94  	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
    95  	Index   int    `positional-arg-name:"INDEX" required:"true" description:"The index of the application instance"`
    96  }
    97  
    98  type OrgSpace struct {
    99  	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
   100  	Space        string `positional-arg-name:"SPACE" required:"true" description:"The space"`
   101  }
   102  
   103  type ServiceInstanceKey struct {
   104  	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
   105  	ServiceKey      string `positional-arg-name:"SERVICE_KEY" required:"true" description:"The service key"`
   106  }
   107  
   108  type AppDomain struct {
   109  	App    string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   110  	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
   111  }
   112  
   113  type HostDomain struct {
   114  	Host   string `positional-arg-name:"HOST" required:"true" description:"The hostname"`
   115  	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
   116  }
   117  
   118  type OrgDomain struct {
   119  	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
   120  	Domain       string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
   121  }
   122  
   123  type SpaceDomain struct {
   124  	Space  string `positional-arg-name:"SPACE" required:"true" description:"The space"`
   125  	Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"`
   126  }
   127  
   128  type BindSecurityGroupArgs struct {
   129  	SecurityGroupName string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group name"`
   130  	OrganizationName  string `positional-arg-name:"ORG" required:"true" description:"The organization group name"`
   131  	SpaceName         string `positional-arg-name:"SPACE" description:"The space name"`
   132  }
   133  
   134  type UnbindSecurityGroupArgs struct {
   135  	SecurityGroupName string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group name"`
   136  	OrganizationName  string `positional-arg-name:"ORG" description:"The organization group name"`
   137  	SpaceName         string `positional-arg-name:"SPACE" description:"The space name"`
   138  }
   139  
   140  type FilesArgs struct {
   141  	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   142  	Path    string `positional-arg-name:"PATH" description:"The file path"`
   143  }
   144  
   145  type SetEnvironmentArgs struct {
   146  	AppName                  string              `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   147  	EnvironmentVariableName  string              `positional-arg-name:"ENV_VAR_NAME" required:"true" description:"The environment variable name"`
   148  	EnvironmentVariableValue EnvironmentVariable `positional-arg-name:"ENV_VAR_VALUE" required:"true" description:"The environment variable value"`
   149  }
   150  
   151  type UnsetEnvironmentArgs struct {
   152  	AppName                 string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   153  	EnvironmentVariableName string `positional-arg-name:"ENV_VAR_NAME" required:"true" description:"The environment variable name"`
   154  }
   155  
   156  type CopySourceArgs struct {
   157  	SourceAppName string `positional-arg-name:"SOURCE-APP" required:"true" description:"The old application name"`
   158  	TargetAppName string `positional-arg-name:"TARGET-NAME" required:"true" description:"The new application name"`
   159  }
   160  
   161  type CreateServiceArgs struct {
   162  	ServiceOffering string `positional-arg-name:"SERVICE" required:"true" description:"The service offering"`
   163  	ServicePlan     string `positional-arg-name:"SERVICE_PLAN" required:"true" description:"The service plan that the service instance will use"`
   164  	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
   165  }
   166  
   167  type RenameServiceArgs struct {
   168  	ServiceInstance        string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance to rename"`
   169  	NewServiceInstanceName string `positional-arg-name:"NEW_SERVICE_INSTANCE" required:"true" description:"The new name of the service instance"`
   170  }
   171  
   172  type BindServiceArgs struct {
   173  	AppName             string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   174  	ServiceInstanceName string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
   175  }
   176  
   177  type RouteServiceArgs struct {
   178  	Domain          string `positional-arg-name:"DOMAIN" required:"true" description:"The domain of the route"`
   179  	ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"`
   180  }
   181  
   182  type AppRenameArgs struct {
   183  	OldAppName string `positional-arg-name:"APP_NAME" required:"true" description:"The old application name"`
   184  	NewAppName string `positional-arg-name:"NEW_APP_NAME" required:"true" description:"The new application name"`
   185  }
   186  
   187  type RenameOrgArgs struct {
   188  	OldOrgName string `positional-arg-name:"ORG" required:"true" description:"The old organization name"`
   189  	NewOrgName string `positional-arg-name:"NEW_ORG" required:"true" description:"The new organization name"`
   190  }
   191  
   192  type RenameSpaceArgs struct {
   193  	OldSpaceName string `positional-arg-name:"SPACE_NAME" required:"true" description:"The old space name"`
   194  	NewSpaceName string `positional-arg-name:"NEW_SPACE_NAME" required:"true" description:"The new space name"`
   195  }
   196  
   197  type SetOrgQuotaArgs struct {
   198  	Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"`
   199  	Quota        string `positional-arg-name:"QUOTA" required:"true" description:"The quota"`
   200  }
   201  
   202  type SetSpaceQuotaArgs struct {
   203  	Space      string `positional-arg-name:"SPACE_NAME" required:"true" description:"The space"`
   204  	SpaceQuota string `positional-arg-name:"SPACE_QUOTA" required:"true" description:"The space quota"`
   205  }
   206  
   207  type SetHealthCheckArgs struct {
   208  	AppName     string          `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   209  	HealthCheck HealthCheckType `positional-arg-name:"HEALTH_CHECK_TYPE" required:"true" description:"Set to 'port' or 'none'"`
   210  }
   211  
   212  type CreateBuildpackArgs struct {
   213  	Buildpack string                      `positional-arg-name:"BUILDPACK" required:"true" description:"The buildpack"`
   214  	Path      PathWithExistenceCheckOrURL `positional-arg-name:"PATH" required:"true" description:"The path to the buildpack file"`
   215  	Position  string                      `positional-arg-name:"POSITION" required:"true" description:"The position that sets priority"`
   216  }
   217  
   218  type RenameBuildpackArgs struct {
   219  	OldBuildpackName string `positional-arg-name:"BUILDPACK_NAME" required:"true" description:"The old buildpack name"`
   220  	NewBuildpackName string `positional-arg-name:"NEW_BUILDPACK_NAME" required:"true" description:"The new buildpack name"`
   221  }
   222  
   223  type SetOrgRoleArgs struct {
   224  	Username     string  `positional-arg-name:"USERNAME" required:"true" description:"The user"`
   225  	Organization string  `positional-arg-name:"ORG" required:"true" description:"The organization"`
   226  	Role         OrgRole `positional-arg-name:"ROLE" required:"true" description:"The organization role"`
   227  }
   228  
   229  type SetSpaceRoleArgs struct {
   230  	Username     string    `positional-arg-name:"USERNAME" required:"true" description:"The user"`
   231  	Organization string    `positional-arg-name:"ORG" required:"true" description:"The organization"`
   232  	Space        string    `positional-arg-name:"ORG" required:"true" description:"The space"`
   233  	Role         SpaceRole `positional-arg-name:"ROLE" required:"true" description:"The space role"`
   234  }
   235  
   236  type ServiceAuthTokenArgs struct {
   237  	Label    string `positional-arg-name:"LABEL" required:"true" description:"The token label"`
   238  	Provider string `positional-arg-name:"PROVIDER" required:"true" description:"The token provider"`
   239  	Token    string `positional-arg-name:"TOKEN" required:"true" description:"The token"`
   240  }
   241  
   242  type DeleteServiceAuthTokenArgs struct {
   243  	Label    string `positional-arg-name:"LABEL" required:"true" description:"The token label"`
   244  	Provider string `positional-arg-name:"PROVIDER" required:"true" description:"The token provider"`
   245  }
   246  
   247  type ServiceBrokerArgs struct {
   248  	ServiceBroker string `positional-arg-name:"SERVICE_BROKER" required:"true" description:"The service broker name"`
   249  	Username      string `positional-arg-name:"USERNAME" required:"true" description:"The username"`
   250  	Password      string `positional-arg-name:"PASSWORD" required:"true" description:"The password"`
   251  	URL           string `positional-arg-name:"URL" required:"true" description:"The URL of the service broker"`
   252  }
   253  
   254  type RenameServiceBrokerArgs struct {
   255  	OldServiceBrokerName string `positional-arg-name:"SERVICE_BROKER" required:"true" description:"The old service broker name"`
   256  	NewServiceBrokerName string `positional-arg-name:"NEW_SERVICE_BROKER" required:"true" description:"The new service broker name"`
   257  }
   258  
   259  type MigrateServiceInstancesArgs struct {
   260  	V1Service  string `positional-arg-name:"v1_SERVICE" required:"true" description:"The old service offering"`
   261  	V1Provider string `positional-arg-name:"v1_PROVIDER" required:"true" description:"The old service provider"`
   262  	V1Plan     string `positional-arg-name:"v1_PLAN" required:"true" description:"The old service plan"`
   263  	V2Service  string `positional-arg-name:"v2_SERVICE" required:"true" description:"The new service offering"`
   264  	V2Plan     string `positional-arg-name:"v2_PLAN" required:"true" description:"The new service plan"`
   265  }
   266  
   267  type SecurityGroupArgs struct {
   268  	SecurityGroup   string                 `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group"`
   269  	PathToJsonRules PathWithExistenceCheck `positional-arg-name:"PATH_TO_JSON_RULES_FILE" required:"true" description:"Path to file of JSON describing security group rules"`
   270  }
   271  
   272  type AddPluginRepoArgs struct {
   273  	PluginRepoName string `positional-arg-name:"REPO_NAME" required:"true" description:"The plugin repo name"`
   274  	PluginRepoURL  string `positional-arg-name:"URL" required:"true" description:"The URL to the plugin repo"`
   275  }
   276  
   277  type InstallPluginArgs struct {
   278  	PluginNameOrLocation Path `positional-arg-name:"PLUGIN_NAME_OR_LOCATION" required:"true" description:"The local path to the plugin, if the plugin exists locally; the URL to the plugin, if the plugin exists online; or the plugin name, if a repo is specified"`
   279  }
   280  
   281  type RunTaskArgs struct {
   282  	AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   283  	Command string `positional-arg-name:"COMMAND" required:"true" description:"The command to execute"`
   284  }
   285  
   286  type TerminateTaskArgs struct {
   287  	AppName    string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"`
   288  	SequenceID string `positional-arg-name:"TASK_ID" required:"true" description:"The task's unique sequence ID"`
   289  }
   290  
   291  type IsolationSegmentName struct {
   292  	IsolationSegmentName string `positional-arg-name:"SEGMENT_NAME" required:"true" description:"The isolation segment name"`
   293  }
   294  
   295  type OrgIsolationArgs struct {
   296  	OrganizationName     string `positional-arg-name:"ORG_NAME" required:"true" description:"The organization name"`
   297  	IsolationSegmentName string `positional-arg-name:"SEGMENT_NAME" required:"true" description:"The isolation segment name"`
   298  }
   299  
   300  type SpaceIsolationArgs struct {
   301  	SpaceName            string `positional-arg-name:"SPACE_NAME" required:"true" description:"The space name"`
   302  	IsolationSegmentName string `positional-arg-name:"SEGMENT_NAME" required:"true" description:"The isolation segment name"`
   303  }
   304  
   305  type ResetSpaceIsolationArgs struct {
   306  	SpaceName string `positional-arg-name:"SPACE_NAME" required:"true" description:"The space name"`
   307  }