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