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