github.com/dcarley/cf-cli@v6.24.1-0.20170220111324-4225ff346898+incompatible/command/flag/arguments.go (about)

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