github.com/mook-as/cf-cli@v7.0.0-beta.28.0.20200120190804-b91c115fae48+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 OptionalAppName struct { 8 AppName string `positional-arg-name:"APP_NAME" description:"The application name"` 9 } 10 11 type BuildpackName struct { 12 Buildpack string `positional-arg-name:"BUILDPACK" required:"true" description:"The buildpack"` 13 } 14 15 type CommandName struct { 16 CommandName string `positional-arg-name:"COMMAND_NAME" description:"The command name"` 17 } 18 19 type Domain struct { 20 Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"` 21 } 22 23 type Feature struct { 24 Feature string `positional-arg-name:"FEATURE_NAME" required:"true" description:"The feature flag name"` 25 } 26 27 type ParamsAsJSON struct { 28 JSON string `positional-arg-name:"JSON" required:"true" description:"Parameters as JSON"` 29 } 30 31 type Service struct { 32 Service string `positional-arg-name:"SERVICE" required:"true" description:"The service offering name"` 33 } 34 35 type ServiceInstance struct { 36 ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance name"` 37 } 38 39 type Organization struct { 40 Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"` 41 } 42 43 type APIPath struct { 44 Path string `positional-arg-name:"PATH" required:"true" description:"The API endpoint"` 45 } 46 47 type PluginRepoName struct { 48 PluginRepoName string `positional-arg-name:"REPO_NAME" required:"true" description:"The plugin repo name"` 49 } 50 51 type PluginName struct { 52 PluginName string `positional-arg-name:"PLUGIN_NAME" required:"true" description:"The plugin name"` 53 } 54 55 type Quota struct { 56 Quota string `positional-arg-name:"QUOTA" required:"true" description:"The organization quota"` 57 } 58 59 type SecurityGroup struct { 60 ServiceGroup string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group"` 61 } 62 63 type Space struct { 64 Space string `positional-arg-name:"SPACE" required:"true" description:"The space"` 65 } 66 67 type Rename struct { 68 OldAppName string `positional-arg-name:"APP_NAME" required:"true" description:"The current app name"` 69 NewAppName string `positional-arg-name:"NEW_APP_NAME" required:"true" description:"The new app name"` 70 } 71 72 type RenameSpace struct { 73 OldSpaceName string `positional-arg-name:"SPACE" required:"true" description:"The old space name"` 74 NewSpaceName string `positional-arg-name:"NEW_SPACE_NAME" required:"true" description:"The new space name"` 75 } 76 77 type SpaceQuota struct { 78 SpaceQuota string `positional-arg-name:"SPACE_QUOTA_NAME" required:"true" description:"The space quota"` 79 } 80 81 type StackName struct { 82 StackName string `positional-arg-name:"STACK_NAME" required:"true" description:"The stack name"` 83 } 84 85 type Username struct { 86 Username string `positional-arg-name:"USERNAME" required:"true" description:"The username"` 87 } 88 89 type APITarget struct { 90 URL string `positional-arg-name:"URL" description:"API URL to target"` 91 } 92 93 type Authentication struct { 94 Username string `positional-arg-name:"USERNAME" description:"The username"` 95 Password string `positional-arg-name:"PASSWORD" description:"The password"` 96 } 97 98 type CreateUser struct { 99 Username string `positional-arg-name:"USERNAME" required:"true" description:"The username"` 100 Password *string `positional-arg-name:"PASSWORD" description:"The password"` 101 } 102 103 type AppInstance struct { 104 AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 105 Index int `positional-arg-name:"INDEX" required:"true" description:"The index of the application instance"` 106 } 107 108 type OrgSpace struct { 109 Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"` 110 Space string `positional-arg-name:"SPACE" required:"true" description:"The space"` 111 } 112 113 type ServiceInstanceKey struct { 114 ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"` 115 ServiceKey string `positional-arg-name:"SERVICE_KEY" required:"true" description:"The service key"` 116 } 117 118 type AppDomain struct { 119 App string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 120 Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"` 121 } 122 123 type HostDomain struct { 124 Host string `positional-arg-name:"HOST" required:"true" description:"The hostname"` 125 Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"` 126 } 127 128 type OrgDomain struct { 129 Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"` 130 Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"` 131 } 132 133 type SpaceDomain struct { 134 Space string `positional-arg-name:"SPACE" required:"true" description:"The space"` 135 Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain"` 136 } 137 138 type BindSecurityGroupArgs struct { 139 SecurityGroupName string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group name"` 140 OrganizationName string `positional-arg-name:"ORG" required:"true" description:"The organization group name"` 141 SpaceName string `positional-arg-name:"SPACE" description:"The space name"` 142 } 143 144 type UnbindSecurityGroupArgs struct { 145 SecurityGroupName string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group name"` 146 OrganizationName string `positional-arg-name:"ORG" description:"The organization group name"` 147 SpaceName string `positional-arg-name:"SPACE" description:"The space name"` 148 } 149 150 type FilesArgs struct { 151 AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 152 Path string `positional-arg-name:"PATH" description:"The file path"` 153 } 154 155 type EnvironmentArgs struct { 156 AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 157 } 158 159 type SetEnvironmentArgs struct { 160 AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 161 EnvironmentVariableName string `positional-arg-name:"ENV_VAR_NAME" required:"true" description:"The environment variable name"` 162 EnvironmentVariableValue EnvironmentVariable `positional-arg-name:"ENV_VAR_VALUE" required:"true" description:"The environment variable value"` 163 } 164 165 type UnsetEnvironmentArgs struct { 166 AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 167 EnvironmentVariableName string `positional-arg-name:"ENV_VAR_NAME" required:"true" description:"The environment variable name"` 168 } 169 170 type CopySourceArgs struct { 171 SourceAppName string `positional-arg-name:"SOURCE-APP" required:"true" description:"The old application name"` 172 TargetAppName string `positional-arg-name:"TARGET-NAME" required:"true" description:"The new application name"` 173 } 174 175 type CreateServiceArgs struct { 176 Service string `positional-arg-name:"SERVICE" required:"true" description:"The service offering"` 177 ServicePlan string `positional-arg-name:"SERVICE_PLAN" required:"true" description:"The service plan that the service instance will use"` 178 ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"` 179 } 180 181 type RenameServiceArgs struct { 182 ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance to rename"` 183 NewServiceInstanceName string `positional-arg-name:"NEW_SERVICE_INSTANCE" required:"true" description:"The new name of the service instance"` 184 } 185 186 type BindServiceArgs struct { 187 AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 188 ServiceInstanceName string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"` 189 } 190 191 type RouteServiceArgs struct { 192 Domain string `positional-arg-name:"DOMAIN" required:"true" description:"The domain of the route"` 193 ServiceInstance string `positional-arg-name:"SERVICE_INSTANCE" required:"true" description:"The service instance"` 194 } 195 196 type AppRenameArgs struct { 197 OldAppName string `positional-arg-name:"APP_NAME" required:"true" description:"The old application name"` 198 NewAppName string `positional-arg-name:"NEW_APP_NAME" required:"true" description:"The new application name"` 199 } 200 201 type RenameOrgArgs struct { 202 OldOrgName string `positional-arg-name:"ORG" required:"true" description:"The old organization name"` 203 NewOrgName string `positional-arg-name:"NEW_ORG_NAME" required:"true" description:"The new organization name"` 204 } 205 206 type RenameSpaceArgs struct { 207 OldSpaceName string `positional-arg-name:"SPACE_NAME" required:"true" description:"The old space name"` 208 NewSpaceName string `positional-arg-name:"NEW_SPACE_NAME" required:"true" description:"The new space name"` 209 } 210 211 type SetOrgQuotaArgs struct { 212 Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"` 213 Quota string `positional-arg-name:"QUOTA" required:"true" description:"The quota"` 214 } 215 216 type SetSpaceQuotaArgs struct { 217 Space string `positional-arg-name:"SPACE_NAME" required:"true" description:"The space"` 218 SpaceQuota string `positional-arg-name:"SPACE_QUOTA" required:"true" description:"The space quota"` 219 } 220 221 type SetEnvVarGroup struct { 222 EnvVarGroupJson string `positional-arg-name:"JSON_STRING" required:"true" description:"json string"` 223 } 224 225 type V6SetHealthCheckArgs struct { 226 AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 227 HealthCheck HealthCheckTypeWithDeprecatedValue `positional-arg-name:"HEALTH_CHECK_TYPE" required:"true" description:"Set to 'port' or 'none'"` 228 } 229 230 type SetHealthCheckArgs struct { 231 AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 232 HealthCheck HealthCheckType `positional-arg-name:"HEALTH_CHECK_TYPE" required:"true" description:"Set to 'port'"` 233 } 234 235 type CreateBuildpackArgs struct { 236 Buildpack string `positional-arg-name:"BUILDPACK" required:"true" description:"The buildpack"` 237 Path PathWithExistenceCheckOrURL `positional-arg-name:"PATH" required:"true" description:"The path to the buildpack file"` 238 Position int `positional-arg-name:"POSITION" required:"true" description:"The position that sets priority"` 239 } 240 241 type RenameBuildpackArgs struct { 242 OldBuildpackName string `positional-arg-name:"BUILDPACK_NAME" required:"true" description:"The old buildpack name"` 243 NewBuildpackName string `positional-arg-name:"NEW_BUILDPACK_NAME" required:"true" description:"The new buildpack name"` 244 } 245 246 type LabelsArgs struct { 247 ResourceType string `positional-arg-name:"RESOURCE" required:"true" description:"The type of resource to label"` 248 ResourceName string `positional-arg-name:"RESOURCE_NAME" required:"true" description:"The name of the resource"` 249 } 250 251 type SetLabelArgs struct { 252 ResourceType string `positional-arg-name:"RESOURCE" required:"true" description:"The type of resource to label"` 253 ResourceName string `positional-arg-name:"RESOURCE_NAME" required:"true" description:"The name of the resource"` 254 Labels []string `positional-arg-name:"KEY=VALUE" required:"true" description:"A space-separated list of labels to set on the resource"` 255 } 256 257 type UnsetLabelArgs struct { 258 ResourceType string `positional-arg-name:"RESOURCE" required:"true" description:"The type of resource"` 259 ResourceName string `positional-arg-name:"RESOURCE_NAME" required:"true" description:"The name of the resource"` 260 LabelKeys []string `positional-arg-name:"KEY" required:"true" description:"A label to unset on the resource"` 261 } 262 type OrgRoleArgs struct { 263 Username string `positional-arg-name:"USERNAME" required:"true" description:"The user"` 264 Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"` 265 Role OrgRole `positional-arg-name:"ROLE" required:"true" description:"The organization role"` 266 } 267 268 type SpaceRoleArgs struct { 269 Username string `positional-arg-name:"USERNAME" required:"true" description:"The user"` 270 Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"` 271 Space string `positional-arg-name:"SPACE" required:"true" description:"The space"` 272 Role SpaceRole `positional-arg-name:"ROLE" required:"true" description:"The space role"` 273 } 274 275 type SpaceUsersArgs struct { 276 Organization string `positional-arg-name:"ORG" required:"true" description:"The organization"` 277 Space string `positional-arg-name:"SPACE" required:"true" description:"The space"` 278 } 279 280 type ServiceAuthTokenArgs struct { 281 Label string `positional-arg-name:"LABEL" required:"true" description:"The token label"` 282 Provider string `positional-arg-name:"PROVIDER" required:"true" description:"The token provider"` 283 Token string `positional-arg-name:"TOKEN" required:"true" description:"The token"` 284 } 285 286 type DeleteServiceAuthTokenArgs struct { 287 Label string `positional-arg-name:"LABEL" required:"true" description:"The token label"` 288 Provider string `positional-arg-name:"PROVIDER" required:"true" description:"The token provider"` 289 } 290 291 type ServiceBroker struct { 292 ServiceBroker string `positional-arg-name:"SERVICE_BROKER" required:"true" description:"The service broker"` 293 } 294 295 type ServiceBrokerArgs struct { 296 ServiceBroker string `positional-arg-name:"SERVICE_BROKER" required:"true" description:"The service broker name"` 297 Username string `positional-arg-name:"USERNAME" required:"true" description:"The username"` 298 Password string `positional-arg-name:"PASSWORD" required:"true" description:"The password"` 299 URL string `positional-arg-name:"URL" required:"true" description:"The URL of the service broker"` 300 } 301 302 type RenameServiceBrokerArgs struct { 303 OldServiceBrokerName string `positional-arg-name:"SERVICE_BROKER" required:"true" description:"The old service broker name"` 304 NewServiceBrokerName string `positional-arg-name:"NEW_SERVICE_BROKER" required:"true" description:"The new service broker name"` 305 } 306 307 type MigrateServiceInstancesArgs struct { 308 V1Service string `positional-arg-name:"v1_SERVICE" required:"true" description:"The old service offering"` 309 V1Provider string `positional-arg-name:"v1_PROVIDER" required:"true" description:"The old service provider"` 310 V1Plan string `positional-arg-name:"v1_PLAN" required:"true" description:"The old service plan"` 311 V2Service string `positional-arg-name:"v2_SERVICE" required:"true" description:"The new service offering"` 312 V2Plan string `positional-arg-name:"v2_PLAN" required:"true" description:"The new service plan"` 313 } 314 315 type SecurityGroupArgs struct { 316 SecurityGroup string `positional-arg-name:"SECURITY_GROUP" required:"true" description:"The security group"` 317 PathToJSONRules PathWithExistenceCheck `positional-arg-name:"PATH_TO_JSON_RULES_FILE" required:"true" description:"Path to file of JSON describing security group rules"` 318 } 319 320 type AddPluginRepoArgs struct { 321 PluginRepoName string `positional-arg-name:"REPO_NAME" required:"true" description:"The plugin repo name"` 322 PluginRepoURL string `positional-arg-name:"URL" required:"true" description:"The URL to the plugin repo"` 323 } 324 325 type InstallPluginArgs struct { 326 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"` 327 } 328 329 type RunTaskArgs struct { 330 AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 331 Command string `positional-arg-name:"COMMAND" required:"true" description:"The command to execute"` 332 } 333 334 type RunTaskArgsV7 struct { 335 AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 336 } 337 338 type TerminateTaskArgs struct { 339 AppName string `positional-arg-name:"APP_NAME" required:"true" description:"The application name"` 340 SequenceID string `positional-arg-name:"TASK_ID" required:"true" description:"The task's unique sequence ID"` 341 } 342 343 type IsolationSegmentName struct { 344 IsolationSegmentName string `positional-arg-name:"SEGMENT_NAME" required:"true" description:"The isolation segment name"` 345 } 346 347 type OrgIsolationArgs struct { 348 OrganizationName string `positional-arg-name:"ORG_NAME" required:"true" description:"The organization name"` 349 IsolationSegmentName string `positional-arg-name:"SEGMENT_NAME" required:"true" description:"The isolation segment name"` 350 } 351 352 type SpaceIsolationArgs struct { 353 SpaceName string `positional-arg-name:"SPACE_NAME" required:"true" description:"The space name"` 354 IsolationSegmentName string `positional-arg-name:"SEGMENT_NAME" required:"true" description:"The isolation segment name"` 355 } 356 357 type ResetSpaceIsolationArgs struct { 358 SpaceName string `positional-arg-name:"SPACE_NAME" required:"true" description:"The space name"` 359 } 360 361 type ResetOrgDefaultIsolationArgs struct { 362 OrgName string `positional-arg-name:"ORG_NAME" required:"true" description:"The organization name"` 363 } 364 365 type AddNetworkPolicyArgs struct { 366 SourceApp string `positional-arg-name:"SOURCE_APP" required:"true" description:"The source app"` 367 } 368 369 type RemoveNetworkPolicyArgs struct { 370 SourceApp string 371 }