diff --git a/cmd/kube_nodepool.go b/cmd/kube_nodepool.go index 93d61a06..ee2f8bea 100644 --- a/cmd/kube_nodepool.go +++ b/cmd/kube_nodepool.go @@ -26,7 +26,7 @@ func init() { return slices.Contains([]string{"List", "Get", "Create", "Update", "Delete"}, m.Name) }, kubeapi("kubeclient_nodepool")) apiCmd, _ := lo.Find(nodepoolCmd.Commands(), func(c *cobra.Command) bool { return c.Name() == "api" }) - apiCmd.PersistentFlags().String("cluster", "", "Name or ID of cluster") + apiCmd.PersistentFlags().String("cluster", "", "[REQUIRED] Name or ID of cluster") _ = apiCmd.MarkPersistentFlagRequired("cluster") apiCmd.PersistentFlags().String("project", preferences.Preferences.Kube.DefaultProject, "Name or ID of project") // nodepool commands need to be added to the upper level, otherwise we will get kube nodepool nodepool diff --git a/cmd/kube_secret.go b/cmd/kube_secret.go index 93b5eb49..79cc9e53 100644 --- a/cmd/kube_secret.go +++ b/cmd/kube_secret.go @@ -43,7 +43,7 @@ var ( func init() { oksCmd.AddCommand(secretCmd) - secretCmd.Flags().String("name", "", "name of secret") + secretCmd.Flags().String("name", "", "[REQUIRED] name of secret") secretCmd.Flags().String("namespace", "kube-system", "namespace of secret") _ = secretCmd.MarkFlagRequired("name") } diff --git a/docs/reference/octl_iaas_account_create.md b/docs/reference/octl_iaas_account_create.md index 8dfc3d9c..c1f46ad3 100644 --- a/docs/reference/octl_iaas_account_create.md +++ b/docs/reference/octl_iaas_account_create.md @@ -24,20 +24,20 @@ octl iaas account create [flags] ``` --additional-email strings One or more additional email addresses for the account. - --city string The city of the account owner. - --company-name string The name of the company for the account. - --country string The country of the account owner. - --customer-id string The ID of the customer. - --email string The main email address for the account. - --first-name string The first name of the account owner. + --city string [REQUIRED] The city of the account owner. + --company-name string [REQUIRED] The name of the company for the account. + --country string [REQUIRED] The country of the account owner. + --customer-id string [REQUIRED] The ID of the customer. + --email string [REQUIRED] The main email address for the account. + --first-name string [REQUIRED] The first name of the account owner. -h, --help help for create --job-title string The job title of the account owner. - --last-name string The last name of the account owner. + --last-name string [REQUIRED] The last name of the account owner. --mobile-number string The mobile phone number of the account owner. --phone-number string The landline phone number of the account owner. --state-province string The state/province of the account. --vat-number string The value added tax (VAT) number for the account. - --zip-code string The ZIP code of the city. + --zip-code string [REQUIRED] The ZIP code of the city. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_adminpassword_list.md b/docs/reference/octl_iaas_adminpassword_list.md index b70b003f..789476d7 100644 --- a/docs/reference/octl_iaas_adminpassword_list.md +++ b/docs/reference/octl_iaas_adminpassword_list.md @@ -24,7 +24,7 @@ octl iaas adminpassword list [flags] ``` -h, --help help for list - --vm-id string The ID of the VM. + --vm-id string [REQUIRED] The ID of the VM. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_ca_create.md b/docs/reference/octl_iaas_ca_create.md index 3e07e651..b233963b 100644 --- a/docs/reference/octl_iaas_ca_create.md +++ b/docs/reference/octl_iaas_ca_create.md @@ -19,7 +19,7 @@ octl iaas ca create [flags] ``` --description string The description of the CA. -h, --help help for create - --pem string The CA in PEM format. + --pem string [REQUIRED] The CA in PEM format. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_clientgateway_create.md b/docs/reference/octl_iaas_clientgateway_create.md index affec1e6..2da9d8d1 100644 --- a/docs/reference/octl_iaas_clientgateway_create.md +++ b/docs/reference/octl_iaas_clientgateway_create.md @@ -21,10 +21,10 @@ octl iaas clientgateway create [flags] ### Options ``` - --bgp-asn int The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. - --connection-type string The communication protocol used to establish tunnel with your client gateway (always ipsec.1). + --bgp-asn int [REQUIRED] The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet. + --connection-type string [REQUIRED] The communication protocol used to establish tunnel with your client gateway (always ipsec.1). -h, --help help for create - --public-ip string The public fixed IPv4 address of your client gateway. + --public-ip string [REQUIRED] The public fixed IPv4 address of your client gateway. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_co2emissionaccount_list.md b/docs/reference/octl_iaas_co2emissionaccount_list.md index 533ea6d7..bbcacfa6 100644 --- a/docs/reference/octl_iaas_co2emissionaccount_list.md +++ b/docs/reference/octl_iaas_co2emissionaccount_list.md @@ -15,10 +15,10 @@ octl iaas co2emissionaccount list [flags] ### Options ``` - --from-month osctime The beginning of the time period, in ISO 8601 date format (for example, 2020-06-01). + --from-month osctime [REQUIRED] The beginning of the time period, in ISO 8601 date format (for example, 2020-06-01). -h, --help help for list --overall If false, returns only the CO2 emission of the specific account that sends the request. - --to-month osctime The end of the time period, in ISO 8601 date format (for example, 2020-06-14). + --to-month osctime [REQUIRED] The end of the time period, in ISO 8601 date format (for example, 2020-06-14). ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_consoleoutput_list.md b/docs/reference/octl_iaas_consoleoutput_list.md index 03268a67..c1fa8e19 100644 --- a/docs/reference/octl_iaas_consoleoutput_list.md +++ b/docs/reference/octl_iaas_consoleoutput_list.md @@ -20,7 +20,7 @@ octl iaas consoleoutput list [flags] ``` -h, --help help for list - --vm-id string The ID of the VM. + --vm-id string [REQUIRED] The ID of the VM. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_dedicatedgroup_create.md b/docs/reference/octl_iaas_dedicatedgroup_create.md index 6c42273f..c21657af 100644 --- a/docs/reference/octl_iaas_dedicatedgroup_create.md +++ b/docs/reference/octl_iaas_dedicatedgroup_create.md @@ -17,10 +17,10 @@ octl iaas dedicatedgroup create [flags] ### Options ``` - --cpu-generation int The processor generation for the VMs in the dedicated group (for example, 4). + --cpu-generation int [REQUIRED] The processor generation for the VMs in the dedicated group (for example, 4). -h, --help help for create - --name string A name for the dedicated group. - --subregion string The Subregion in which you want to create the dedicated group. + --name string [REQUIRED] A name for the dedicated group. + --subregion string [REQUIRED] The Subregion in which you want to create the dedicated group. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_dedicatedgroup_update.md b/docs/reference/octl_iaas_dedicatedgroup_update.md index 8dd14d2c..7dc611a5 100644 --- a/docs/reference/octl_iaas_dedicatedgroup_update.md +++ b/docs/reference/octl_iaas_dedicatedgroup_update.md @@ -16,7 +16,7 @@ octl iaas dedicatedgroup update dedicated_group_id [dedicated_group_id]... [flag ``` -h, --help help for update - --name string The new name of the dedicated group. + --name string [REQUIRED] The new name of the dedicated group. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_directlink_create.md b/docs/reference/octl_iaas_directlink_create.md index 422f54d5..2405a65c 100644 --- a/docs/reference/octl_iaas_directlink_create.md +++ b/docs/reference/octl_iaas_directlink_create.md @@ -17,10 +17,10 @@ octl iaas directlink create [flags] ### Options ``` - --bandwidth string The bandwidth of the DirectLink (1Gbps | 10Gbps). + --bandwidth string [REQUIRED] The bandwidth of the DirectLink (1Gbps | 10Gbps). -h, --help help for create - --location string The code of the requested location for the DirectLink, returned by the [ReadLocations](#readlocations) method. - --name string The name of the DirectLink. + --location string [REQUIRED] The code of the requested location for the DirectLink, returned by the [ReadLocations](#readlocations) method. + --name string [REQUIRED] The name of the DirectLink. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_directlinkinterface_create.md b/docs/reference/octl_iaas_directlinkinterface_create.md index 97b08f9f..c07ce639 100644 --- a/docs/reference/octl_iaas_directlinkinterface_create.md +++ b/docs/reference/octl_iaas_directlinkinterface_create.md @@ -19,15 +19,15 @@ octl iaas directlinkinterface create [flags] ### Options ``` - --bgp-asn int + --bgp-asn int [REQUIRED] --bgp-key string --client-private-ip string - --direct-link-id string The ID of the existing DirectLink for which you want to create the DirectLink interface. - --direct-link-interface-name string + --direct-link-id string [REQUIRED] The ID of the existing DirectLink for which you want to create the DirectLink interface. + --direct-link-interface-name string [REQUIRED] -h, --help help for create --outscale-private-ip string - --virtual-gateway-id string - --vlan int + --virtual-gateway-id string [REQUIRED] + --vlan int [REQUIRED] ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_directlinkinterface_update.md b/docs/reference/octl_iaas_directlinkinterface_update.md index 72cb29b4..a8fdfcf3 100644 --- a/docs/reference/octl_iaas_directlinkinterface_update.md +++ b/docs/reference/octl_iaas_directlinkinterface_update.md @@ -16,7 +16,7 @@ octl iaas directlinkinterface update direct_link_interface_id [direct_link_inter ``` -h, --help help for update - --mtu int The maximum transmission unit (MTU) of the DirectLink interface, in bytes. + --mtu int [REQUIRED] The maximum transmission unit (MTU) of the DirectLink interface, in bytes. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_entitieslinkedtopolicy_list.md b/docs/reference/octl_iaas_entitieslinkedtopolicy_list.md index 9b70c561..10ff66f4 100644 --- a/docs/reference/octl_iaas_entitieslinkedtopolicy_list.md +++ b/docs/reference/octl_iaas_entitieslinkedtopolicy_list.md @@ -18,7 +18,7 @@ octl iaas entitieslinkedtopolicy list [flags] --entity-type strings The type of entity linked to the policy you want to get information about. --first-item int The item starting the list of entities requested. -h, --help help for list - --policy-orn string The OUTSCALE Resource Name (ORN) of the policy. + --policy-orn string [REQUIRED] The OUTSCALE Resource Name (ORN) of the policy. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_flexiblegpu_create.md b/docs/reference/octl_iaas_flexiblegpu_create.md index 4d648508..b3cf394b 100644 --- a/docs/reference/octl_iaas_flexiblegpu_create.md +++ b/docs/reference/octl_iaas_flexiblegpu_create.md @@ -22,8 +22,8 @@ octl iaas flexiblegpu create [flags] --delete-on-vm-deletion If true, the fGPU is deleted when the VM is terminated. --generation string The processor generation that the fGPU must be compatible with. -h, --help help for create - --model-name string The model of fGPU you want to allocate. - --subregion string The Subregion in which you want to create the fGPU. + --model-name string [REQUIRED] The model of fGPU you want to allocate. + --subregion string [REQUIRED] The Subregion in which you want to create the fGPU. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_flexiblegpu_link.md b/docs/reference/octl_iaas_flexiblegpu_link.md index 5348c7b2..6c95607d 100644 --- a/docs/reference/octl_iaas_flexiblegpu_link.md +++ b/docs/reference/octl_iaas_flexiblegpu_link.md @@ -22,7 +22,7 @@ octl iaas flexiblegpu link fgpu_id [flags] ``` -h, --help help for link - --vm-id string The ID of the VM you want to attach the fGPU to. + --vm-id string [REQUIRED] The ID of the VM you want to attach the fGPU to. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_imageexporttask_create.md b/docs/reference/octl_iaas_imageexporttask_create.md index 629a7bb9..3a985990 100644 --- a/docs/reference/octl_iaas_imageexporttask_create.md +++ b/docs/reference/octl_iaas_imageexporttask_create.md @@ -30,11 +30,11 @@ octl iaas imageexporttask create [flags] ``` -h, --help help for create - --image-id string The ID of the OMI to export. - --osu-export-disk-image-format string The format of the export disk (qcow2 | raw). + --image-id string [REQUIRED] The ID of the OMI to export. + --osu-export-disk-image-format string [REQUIRED] The format of the export disk (qcow2 | raw). --osu-export-osu-api-key-api-key-id string The API key of the OOS account that enables you to access the bucket. --osu-export-osu-api-key-secret-key string The secret key of the OOS account that enables you to access the bucket. - --osu-export-osu-bucket string The name of the OOS bucket where you want to export the object. + --osu-export-osu-bucket string [REQUIRED] The name of the OOS bucket where you want to export the object. --osu-export-osu-manifest-url string The URL of the manifest file. --osu-export-osu-prefix string The prefix for the key of the OOS object. ``` diff --git a/docs/reference/octl_iaas_internetservice_link.md b/docs/reference/octl_iaas_internetservice_link.md index 90d46ec0..c74104cf 100644 --- a/docs/reference/octl_iaas_internetservice_link.md +++ b/docs/reference/octl_iaas_internetservice_link.md @@ -18,7 +18,7 @@ octl iaas internetservice link service_id [flags] ``` -h, --help help for link - --net-id string The ID of the Net to which you want to attach the internet service. + --net-id string [REQUIRED] The ID of the Net to which you want to attach the internet service. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_internetservice_unlink.md b/docs/reference/octl_iaas_internetservice_unlink.md index 1bddfdd0..640c8f9b 100644 --- a/docs/reference/octl_iaas_internetservice_unlink.md +++ b/docs/reference/octl_iaas_internetservice_unlink.md @@ -18,7 +18,7 @@ octl iaas internetservice unlink service_id [flags] ``` -h, --help help for unlink - --net-id string The ID of the Net from which you want to detach the internet service. + --net-id string [REQUIRED] The ID of the Net from which you want to detach the internet service. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_keypair_create.md b/docs/reference/octl_iaas_keypair_create.md index 907b8fee..9359b7da 100644 --- a/docs/reference/octl_iaas_keypair_create.md +++ b/docs/reference/octl_iaas_keypair_create.md @@ -24,7 +24,7 @@ octl iaas keypair create [flags] ``` -h, --help help for create - --name string A unique name for the keypair, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). + --name string [REQUIRED] A unique name for the keypair, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters). --public-key base64File The file storing the public key to import in your account, if you are importing an existing keypair. ``` diff --git a/docs/reference/octl_iaas_linkedpolicy_list.md b/docs/reference/octl_iaas_linkedpolicy_list.md index 43ae4429..3ce6f0ab 100644 --- a/docs/reference/octl_iaas_linkedpolicy_list.md +++ b/docs/reference/octl_iaas_linkedpolicy_list.md @@ -18,7 +18,7 @@ octl iaas linkedpolicy list [flags] --first-item int The item starting the list of policies requested. -h, --help help for list --path-prefix string The path prefix of the policies. - --user-name string The name of the user the policies are linked to. + --user-name string [REQUIRED] The name of the user the policies are linked to. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_listenerrule_create.md b/docs/reference/octl_iaas_listenerrule_create.md index 6560b379..2695a5fc 100644 --- a/docs/reference/octl_iaas_listenerrule_create.md +++ b/docs/reference/octl_iaas_listenerrule_create.md @@ -22,11 +22,11 @@ octl iaas listenerrule create [flags] --action string The type of action for the rule (always forward). -h, --help help for create --host-name-pattern string A host-name pattern for the rule, with a maximum length of 128 characters. - --listener-load-balancer-name string The name of the load balancer to which the listener is attached. - --listener-load-balancer-port int The port of load balancer on which the load balancer is listening (between 1 and 65535 both included). - --listener-rule-name string A human-readable name for the listener rule. + --listener-load-balancer-name string [REQUIRED] The name of the load balancer to which the listener is attached. + --listener-load-balancer-port int [REQUIRED] The port of load balancer on which the load balancer is listening (between 1 and 65535 both included). + --listener-rule-name string [REQUIRED] A human-readable name for the listener rule. --path-pattern string A path pattern for the rule, with a maximum length of 128 characters. - --priority int The priority level of the listener rule, between 1 and 19999 both included. + --priority int [REQUIRED] The priority level of the listener rule, between 1 and 19999 both included. --vm-id strings The IDs of the backend VMs. ``` diff --git a/docs/reference/octl_iaas_loadbalancer_create.md b/docs/reference/octl_iaas_loadbalancer_create.md index 7aa24bde..129b363a 100644 --- a/docs/reference/octl_iaas_loadbalancer_create.md +++ b/docs/reference/octl_iaas_loadbalancer_create.md @@ -29,7 +29,7 @@ octl iaas loadbalancer create [flags] --listener-load-balancer-port int The port on which the load balancer is listening (between 1 and 65535, both included). --listener-load-balancer-protocol string The routing protocol (HTTP | HTTPS | TCP | SSL). --listener-server-certificate-id string The OUTSCALE Resource Name (ORN) of the server certificate. - --name string The unique name of the load balancer, with a maximum length of 32 alphanumeric characters and dashes (-). + --name string [REQUIRED] The unique name of the load balancer, with a maximum length of 32 alphanumeric characters and dashes (-). --public-ip string (internet-facing only) The public IP you want to associate with the load balancer. --security-group strings (Net only) One or more IDs of security groups you want to assign to the load balancer. --subnet strings (Net only) The ID of the Subnet in which you want to create the load balancer. diff --git a/docs/reference/octl_iaas_loadbalancerlistener_create.md b/docs/reference/octl_iaas_loadbalancerlistener_create.md index 44ba1cbd..78c764e1 100644 --- a/docs/reference/octl_iaas_loadbalancerlistener_create.md +++ b/docs/reference/octl_iaas_loadbalancerlistener_create.md @@ -23,7 +23,7 @@ octl iaas loadbalancerlistener create [flags] --listener-load-balancer-port int The port on which the load balancer is listening (between 1 and 65535, both included). --listener-load-balancer-protocol string The routing protocol (HTTP | HTTPS | TCP | SSL). --listener-server-certificate-id string The OUTSCALE Resource Name (ORN) of the server certificate. - --name string The name of the load balancer for which you want to create listeners. + --name string [REQUIRED] The name of the load balancer for which you want to create listeners. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_loadbalancerpolicy_create.md b/docs/reference/octl_iaas_loadbalancerpolicy_create.md index 23db019d..34a1b778 100644 --- a/docs/reference/octl_iaas_loadbalancerpolicy_create.md +++ b/docs/reference/octl_iaas_loadbalancerpolicy_create.md @@ -30,9 +30,9 @@ octl iaas loadbalancerpolicy create [flags] --cookie-expiration-period int The lifetime of the cookie, in seconds. --cookie-name string The name of the application cookie used for stickiness, between 1 and 255 characters. -h, --help help for create - --name string The name of the load balancer for which you want to create a policy. - --policy-name string The unique name of the policy, with a maximum length of 32 alphanumeric characters and dashes (-). - --policy-type string The type of stickiness policy you want to create: app or load_balancer. + --name string [REQUIRED] The name of the load balancer for which you want to create a policy. + --policy-name string [REQUIRED] The unique name of the policy, with a maximum length of 32 alphanumeric characters and dashes (-). + --policy-type string [REQUIRED] The type of stickiness policy you want to create: app or load_balancer. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_managedpolicieslinkedtousergroup_list.md b/docs/reference/octl_iaas_managedpolicieslinkedtousergroup_list.md index 2a16541a..143ead1a 100644 --- a/docs/reference/octl_iaas_managedpolicieslinkedtousergroup_list.md +++ b/docs/reference/octl_iaas_managedpolicieslinkedtousergroup_list.md @@ -19,7 +19,7 @@ octl iaas managedpolicieslinkedtousergroup list [flags] -h, --help help for list --path-prefix string The path prefix of the groups. --user-group-id strings The IDs of the user groups. - --user-group-name string The name of the group. + --user-group-name string [REQUIRED] The name of the group. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_natservice_create.md b/docs/reference/octl_iaas_natservice_create.md index b9647e92..ca1c4bad 100644 --- a/docs/reference/octl_iaas_natservice_create.md +++ b/docs/reference/octl_iaas_natservice_create.md @@ -29,8 +29,8 @@ octl iaas natservice create [flags] ``` --client-token string A unique identifier which enables you to manage the idempotency. -h, --help help for create - --public-ip-id string The allocation ID of the public IP to associate with the NAT service. - --subnet-id string The ID of the Subnet in which you want to create the NAT service. + --public-ip-id string [REQUIRED] The allocation ID of the public IP to associate with the NAT service. + --subnet-id string [REQUIRED] The ID of the Subnet in which you want to create the NAT service. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_net_create.md b/docs/reference/octl_iaas_net_create.md index bfe8f08f..1bf6c674 100644 --- a/docs/reference/octl_iaas_net_create.md +++ b/docs/reference/octl_iaas_net_create.md @@ -20,7 +20,7 @@ octl iaas net create [flags] ``` -h, --help help for create - --ip-range string The IP range for the Net, in CIDR notation (for example, 10.0.0.0/16). + --ip-range string [REQUIRED] The IP range for the Net, in CIDR notation (for example, 10.0.0.0/16). --tenancy string The tenancy options for the VMs: - default if a VM created in a Net can be launched with any tenancy. ``` diff --git a/docs/reference/octl_iaas_net_update.md b/docs/reference/octl_iaas_net_update.md index 037be550..fa842570 100644 --- a/docs/reference/octl_iaas_net_update.md +++ b/docs/reference/octl_iaas_net_update.md @@ -15,7 +15,7 @@ octl iaas net update net_id [net_id]... [flags] ### Options ``` - --dhcp-options-set-id string The ID of the DHCP options set (or default if you want to associate the default one). + --dhcp-options-set-id string [REQUIRED] The ID of the DHCP options set (or default if you want to associate the default one). -h, --help help for update ``` diff --git a/docs/reference/octl_iaas_netaccesspoint_create.md b/docs/reference/octl_iaas_netaccesspoint_create.md index 107d6165..2744e939 100644 --- a/docs/reference/octl_iaas_netaccesspoint_create.md +++ b/docs/reference/octl_iaas_netaccesspoint_create.md @@ -26,9 +26,9 @@ octl iaas netaccesspoint create [flags] ``` -h, --help help for create - --net-id string The ID of the Net. + --net-id string [REQUIRED] The ID of the Net. --route-table-id strings One or more IDs of route tables to use for the connection. - --service-name string The name of the service (in the format com.outscale.region.service). + --service-name string [REQUIRED] The name of the service (in the format com.outscale.region.service). ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_netpeering_create.md b/docs/reference/octl_iaas_netpeering_create.md index 60e72327..d46ffe6e 100644 --- a/docs/reference/octl_iaas_netpeering_create.md +++ b/docs/reference/octl_iaas_netpeering_create.md @@ -25,10 +25,10 @@ octl iaas netpeering create [flags] ### Options ``` - --accepter-net-id string The ID of the Net you want to connect with. + --accepter-net-id string [REQUIRED] The ID of the Net you want to connect with. --accepter-owner-id string The OUTSCALE account ID of the owner of the Net you want to connect with. -h, --help help for create - --source-net-id string The ID of the Net you send the peering request from. + --source-net-id string [REQUIRED] The ID of the Net you send the peering request from. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_nic_create.md b/docs/reference/octl_iaas_nic_create.md index 1dbacf41..f31776d6 100644 --- a/docs/reference/octl_iaas_nic_create.md +++ b/docs/reference/octl_iaas_nic_create.md @@ -22,7 +22,7 @@ octl iaas nic create [flags] --private-ip-is-primary If true, the IP is the primary private IP of the NIC. --private-ip-private-ip string A private IP for the NIC. --security-group-id strings One or more IDs of security groups for the NIC. - --subnet-id string The ID of the Subnet in which you want to create the NIC. + --subnet-id string [REQUIRED] The ID of the Subnet in which you want to create the NIC. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_nic_link.md b/docs/reference/octl_iaas_nic_link.md index b9fedd34..65534a67 100644 --- a/docs/reference/octl_iaas_nic_link.md +++ b/docs/reference/octl_iaas_nic_link.md @@ -17,9 +17,9 @@ octl iaas nic link nic_id [flags] ### Options ``` - --device-number int The index of the VM device for the NIC attachment (between 1 and 7, both included). + --device-number int [REQUIRED] The index of the VM device for the NIC attachment (between 1 and 7, both included). -h, --help help for link - --vm-id string The ID of the VM to which you want to attach the NIC. + --vm-id string [REQUIRED] The ID of the VM to which you want to attach the NIC. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_policy_create.md b/docs/reference/octl_iaas_policy_create.md index 81ff0553..a952a929 100644 --- a/docs/reference/octl_iaas_policy_create.md +++ b/docs/reference/octl_iaas_policy_create.md @@ -18,9 +18,9 @@ octl iaas policy create [flags] ``` --description string A description for the policy. - --document fileOrJson Either a file storing the policy document or the policy document (in JSON format). + --document fileOrJson [REQUIRED] Either a file storing the policy document or the policy document (in JSON format). -h, --help help for create - --name string The name of the policy. + --name string [REQUIRED] The name of the policy. --path string The path of the policy. ``` diff --git a/docs/reference/octl_iaas_policy_link.md b/docs/reference/octl_iaas_policy_link.md index c9a11bd3..3a8f0121 100644 --- a/docs/reference/octl_iaas_policy_link.md +++ b/docs/reference/octl_iaas_policy_link.md @@ -20,7 +20,7 @@ octl iaas policy link policy_orn [flags] ``` -h, --help help for link - --user-name string The name of the user you want to link the policy to (between 1 and 64 characters). + --user-name string [REQUIRED] The name of the user you want to link the policy to (between 1 and 64 characters). ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_policy_unlink.md b/docs/reference/octl_iaas_policy_unlink.md index 5eab4e77..6e888792 100644 --- a/docs/reference/octl_iaas_policy_unlink.md +++ b/docs/reference/octl_iaas_policy_unlink.md @@ -20,7 +20,7 @@ octl iaas policy unlink policy_orn [flags] ``` -h, --help help for unlink - --user-name string The name of the user you want to detach the policy from. + --user-name string [REQUIRED] The name of the user you want to detach the policy from. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_policyversion_create.md b/docs/reference/octl_iaas_policyversion_create.md index d0dff89f..d000099b 100644 --- a/docs/reference/octl_iaas_policyversion_create.md +++ b/docs/reference/octl_iaas_policyversion_create.md @@ -22,7 +22,7 @@ octl iaas policyversion create policy_orn [flags] ``` --default If set to true, the new policy version is set as the default version and becomes the operative one. - --document fileOrJson Either a file storing the policy document, or the policy document (in JSON format). + --document fileOrJson [REQUIRED] Either a file storing the policy document, or the policy document (in JSON format). -h, --help help for create ``` diff --git a/docs/reference/octl_iaas_policyversion_delete.md b/docs/reference/octl_iaas_policyversion_delete.md index 0ed519d3..be642330 100644 --- a/docs/reference/octl_iaas_policyversion_delete.md +++ b/docs/reference/octl_iaas_policyversion_delete.md @@ -20,7 +20,7 @@ octl iaas policyversion delete policy_orn [flags] ``` -h, --help help for delete - --version string The ID of the version of the policy you want to delete. + --version string [REQUIRED] The ID of the version of the policy you want to delete. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_policyversion_describe.md b/docs/reference/octl_iaas_policyversion_describe.md index 22805d56..e8e25315 100644 --- a/docs/reference/octl_iaas_policyversion_describe.md +++ b/docs/reference/octl_iaas_policyversion_describe.md @@ -16,7 +16,7 @@ octl iaas policyversion describe policy_orn version [flags] ``` -h, --help help for describe - --version string The ID of the policy version. + --version string [REQUIRED] The ID of the policy version. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_policyversion_set-default.md b/docs/reference/octl_iaas_policyversion_set-default.md index ca443176..0fc98a9e 100644 --- a/docs/reference/octl_iaas_policyversion_set-default.md +++ b/docs/reference/octl_iaas_policyversion_set-default.md @@ -22,7 +22,7 @@ octl iaas policyversion set-default policy_orn [flags] ``` -h, --help help for set-default - --version string The ID of the version. + --version string [REQUIRED] The ID of the version. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_producttype_create.md b/docs/reference/octl_iaas_producttype_create.md index c6d566d7..3b3d4038 100644 --- a/docs/reference/octl_iaas_producttype_create.md +++ b/docs/reference/octl_iaas_producttype_create.md @@ -15,7 +15,7 @@ octl iaas producttype create [flags] ### Options ``` - --description string The description of the product type. + --description string [REQUIRED] The description of the product type. -h, --help help for create --vendor string The vendor of the product type. ``` diff --git a/docs/reference/octl_iaas_route_create.md b/docs/reference/octl_iaas_route_create.md index 548a5c1b..b134c502 100644 --- a/docs/reference/octl_iaas_route_create.md +++ b/docs/reference/octl_iaas_route_create.md @@ -33,10 +33,10 @@ octl iaas route create [flags] ### Options ``` - --destination-ip-range string The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24). + --destination-ip-range string [REQUIRED] The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24). --gateway-id string The ID of an internet service or virtual gateway attached to your Net. -h, --help help for create - --id string The ID of the route table for which you want to create a route. + --id string [REQUIRED] The ID of the route table for which you want to create a route. --nat-service-id string The ID of a NAT service. --net-peering-id string The ID of a Net peering. --nic-id string The ID of a NIC. diff --git a/docs/reference/octl_iaas_routetable_create.md b/docs/reference/octl_iaas_routetable_create.md index 13a0fe79..7f16498b 100644 --- a/docs/reference/octl_iaas_routetable_create.md +++ b/docs/reference/octl_iaas_routetable_create.md @@ -20,7 +20,7 @@ octl iaas routetable create [flags] ``` -h, --help help for create - --net-id string The ID of the Net for which you want to create a route table. + --net-id string [REQUIRED] The ID of the Net for which you want to create a route table. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_securitygroup_create.md b/docs/reference/octl_iaas_securitygroup_create.md index 36754f88..c222430e 100644 --- a/docs/reference/octl_iaas_securitygroup_create.md +++ b/docs/reference/octl_iaas_securitygroup_create.md @@ -27,9 +27,9 @@ octl iaas securitygroup create [flags] ### Options ``` - --description string A description for the security group. + --description string [REQUIRED] A description for the security group. -h, --help help for create - --name string The name of the security group. + --name string [REQUIRED] The name of the security group. --net-id string The ID of the Net for the security group. ``` diff --git a/docs/reference/octl_iaas_securitygrouprule_create.md b/docs/reference/octl_iaas_securitygrouprule_create.md index 3be0186f..73b48b19 100644 --- a/docs/reference/octl_iaas_securitygrouprule_create.md +++ b/docs/reference/octl_iaas_securitygrouprule_create.md @@ -36,10 +36,10 @@ octl iaas securitygrouprule create [flags] ``` --account-id-to-link string The OUTSCALE account ID that owns the source or destination security group specified in the SecurityGroupNameToLink parameter. - --flow string The direction of the flow: Inbound or Outbound. + --flow string [REQUIRED] The direction of the flow: Inbound or Outbound. --from-port-range int The beginning of the port range for the TCP and UDP protocols, or an ICMP type number. -h, --help help for create - --id string The ID of the security group for which you want to create a rule. + --id string [REQUIRED] The ID of the security group for which you want to create a rule. --ip-protocol string The IP protocol name (tcp, udp, icmp, or -1 for all protocols). --ip-range string The IP range for the security group rule, in CIDR notation (for example, 10.0.0.0/16). --name-to-link string The ID of a source or destination security group that you want to link to the security group of the rule. diff --git a/docs/reference/octl_iaas_servercertificate_create.md b/docs/reference/octl_iaas_servercertificate_create.md index 46a20a5b..655216e3 100644 --- a/docs/reference/octl_iaas_servercertificate_create.md +++ b/docs/reference/octl_iaas_servercertificate_create.md @@ -27,12 +27,12 @@ octl iaas servercertificate create [flags] ### Options ``` - --body string The PEM-encoded X509 certificate. + --body string [REQUIRED] The PEM-encoded X509 certificate. --chain string The PEM-encoded intermediate certification authorities. -h, --help help for create - --name string A unique name for the certificate. + --name string [REQUIRED] A unique name for the certificate. --path string The path to the server certificate, set to a slash (/) if not specified. - --private-key string The PEM-encoded private key matching the certificate. + --private-key string [REQUIRED] The PEM-encoded private key matching the certificate. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_snapshotexporttask_create.md b/docs/reference/octl_iaas_snapshotexporttask_create.md index 8cb1cb56..f45d45eb 100644 --- a/docs/reference/octl_iaas_snapshotexporttask_create.md +++ b/docs/reference/octl_iaas_snapshotexporttask_create.md @@ -24,13 +24,13 @@ octl iaas snapshotexporttask create [flags] ``` -h, --help help for create - --osu-export-disk-image-format string The format of the export disk (qcow2 | raw). + --osu-export-disk-image-format string [REQUIRED] The format of the export disk (qcow2 | raw). --osu-export-osu-api-key-api-key-id string The API key of the OOS account that enables you to access the bucket. --osu-export-osu-api-key-secret-key string The secret key of the OOS account that enables you to access the bucket. - --osu-export-osu-bucket string The name of the OOS bucket where you want to export the object. + --osu-export-osu-bucket string [REQUIRED] The name of the OOS bucket where you want to export the object. --osu-export-osu-manifest-url string The URL of the manifest file. --osu-export-osu-prefix string The prefix for the key of the OOS object. - --snapshot-id string The ID of the snapshot to export. + --snapshot-id string [REQUIRED] The ID of the snapshot to export. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_subnet_create.md b/docs/reference/octl_iaas_subnet_create.md index 551015ee..f00370d3 100644 --- a/docs/reference/octl_iaas_subnet_create.md +++ b/docs/reference/octl_iaas_subnet_create.md @@ -20,8 +20,8 @@ octl iaas subnet create [flags] ``` -h, --help help for create - --ip-range string The IP range in the Subnet, in CIDR notation (for example, 10.0.0.0/16). - --net-id string The ID of the Net for which you want to create a Subnet. + --ip-range string [REQUIRED] The IP range in the Subnet, in CIDR notation (for example, 10.0.0.0/16). + --net-id string [REQUIRED] The ID of the Net for which you want to create a Subnet. --subregion string The name of the Subregion in which you want to create the Subnet. ``` diff --git a/docs/reference/octl_iaas_subnet_update.md b/docs/reference/octl_iaas_subnet_update.md index 395a9fe4..2a9b2a31 100644 --- a/docs/reference/octl_iaas_subnet_update.md +++ b/docs/reference/octl_iaas_subnet_update.md @@ -16,7 +16,7 @@ octl iaas subnet update subnet_id [subnet_id]... [flags] ``` -h, --help help for update - --map-public-ip-on-launch If true, a public IP is assigned to the network interface cards (NICs) created in the specified Subnet. + --map-public-ip-on-launch [REQUIRED] If true, a public IP is assigned to the network interface cards (NICs) created in the specified Subnet. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_unitprice_list.md b/docs/reference/octl_iaas_unitprice_list.md index d18849e7..80bb8850 100644 --- a/docs/reference/octl_iaas_unitprice_list.md +++ b/docs/reference/octl_iaas_unitprice_list.md @@ -16,9 +16,9 @@ octl iaas unitprice list [flags] ``` -h, --help help for list - --operation string The operation associated with the catalog entry (for example, RunInstances-OD or CreateVolume). - --service string The service associated with the catalog entry (for example, TinaOS-FCU or TinaOS-OOS). - --type string The type associated with the catalog entry (for example, BSU:VolumeIOPS:io1 or BoxUsage:tinav6.c6r16p3). + --operation string [REQUIRED] The operation associated with the catalog entry (for example, RunInstances-OD or CreateVolume). + --service string [REQUIRED] The service associated with the catalog entry (for example, TinaOS-FCU or TinaOS-OOS). + --type string [REQUIRED] The type associated with the catalog entry (for example, BSU:VolumeIOPS:io1 or BoxUsage:tinav6.c6r16p3). ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_user_create.md b/docs/reference/octl_iaas_user_create.md index 3ff72f16..39ed748b 100644 --- a/docs/reference/octl_iaas_user_create.md +++ b/docs/reference/octl_iaas_user_create.md @@ -19,7 +19,7 @@ octl iaas user create [flags] ``` --email string The email address of the EIM user. -h, --help help for create - --name string The name of the EIM user. + --name string [REQUIRED] The name of the EIM user. --path string The path to the EIM user you want to create (by default, /). ``` diff --git a/docs/reference/octl_iaas_usergroup_create.md b/docs/reference/octl_iaas_usergroup_create.md index 0fe82681..e6596c42 100644 --- a/docs/reference/octl_iaas_usergroup_create.md +++ b/docs/reference/octl_iaas_usergroup_create.md @@ -18,7 +18,7 @@ octl iaas usergroup create [flags] ``` -h, --help help for create - --name string The name of the group. + --name string [REQUIRED] The name of the group. --path string The path to the group. ``` diff --git a/docs/reference/octl_iaas_usergrouppolicy_list.md b/docs/reference/octl_iaas_usergrouppolicy_list.md index 5c3e000b..8e584708 100644 --- a/docs/reference/octl_iaas_usergrouppolicy_list.md +++ b/docs/reference/octl_iaas_usergrouppolicy_list.md @@ -17,7 +17,7 @@ octl iaas usergrouppolicy list [flags] ``` --first-item int The item starting the list of policies requested. -h, --help help for list - --user-group-name string The name of the group. + --user-group-name string [REQUIRED] The name of the group. --user-group-path string The path to the group. ``` diff --git a/docs/reference/octl_iaas_usergroupsperuser_list.md b/docs/reference/octl_iaas_usergroupsperuser_list.md index ebe69e4a..337a72d1 100644 --- a/docs/reference/octl_iaas_usergroupsperuser_list.md +++ b/docs/reference/octl_iaas_usergroupsperuser_list.md @@ -16,7 +16,7 @@ octl iaas usergroupsperuser list [flags] ``` -h, --help help for list - --user-name string The name of the user. + --user-name string [REQUIRED] The name of the user. --user-path string The path to the user (by default, /). ``` diff --git a/docs/reference/octl_iaas_userpolicy_list.md b/docs/reference/octl_iaas_userpolicy_list.md index a9fd7f90..8c43c6a7 100644 --- a/docs/reference/octl_iaas_userpolicy_list.md +++ b/docs/reference/octl_iaas_userpolicy_list.md @@ -16,7 +16,7 @@ octl iaas userpolicy list [flags] ``` -h, --help help for list - --user-name string The name of the user. + --user-name string [REQUIRED] The name of the user. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_virtualgateway_create.md b/docs/reference/octl_iaas_virtualgateway_create.md index 4765b327..c7b574c2 100644 --- a/docs/reference/octl_iaas_virtualgateway_create.md +++ b/docs/reference/octl_iaas_virtualgateway_create.md @@ -19,7 +19,7 @@ octl iaas virtualgateway create [flags] ### Options ``` - --connection-type string The type of VPN connection supported by the virtual gateway (always ipsec.1). + --connection-type string [REQUIRED] The type of VPN connection supported by the virtual gateway (always ipsec.1). -h, --help help for create ``` diff --git a/docs/reference/octl_iaas_vm_create.md b/docs/reference/octl_iaas_vm_create.md index f1cd19b7..7c7bf919 100644 --- a/docs/reference/octl_iaas_vm_create.md +++ b/docs/reference/octl_iaas_vm_create.md @@ -38,7 +38,7 @@ octl iaas vm create [flags] --client-token string A unique identifier which enables you to manage the idempotency. --deletion-protection If true, you cannot delete the VM unless you change this parameter back to false. -h, --help help for create - --image-id string The ID of the OMI used to create the VM. + --image-id string [REQUIRED] The ID of the OMI used to create the VM. --initiated-shutdown-behavior string The VM behavior when you stop it. --keypair-name string The name of the keypair. --max-vm-count int The maximum number of VMs you want to create. diff --git a/docs/reference/octl_iaas_vmgroup_create.md b/docs/reference/octl_iaas_vmgroup_create.md index 1603e5f4..b21a1eca 100644 --- a/docs/reference/octl_iaas_vmgroup_create.md +++ b/docs/reference/octl_iaas_vmgroup_create.md @@ -23,14 +23,14 @@ octl iaas vmgroup create [flags] ``` --description string A description for the VM group. -h, --help help for create - --name string The name of the VM group. + --name string [REQUIRED] The name of the VM group. --positioning-strategy string The positioning strategy of VMs on hypervisors. --security-group-id strings One or more IDs of security groups for the VM group. - --subnet-id string The ID of the Subnet in which you want to create the VM group. + --subnet-id string [REQUIRED] The ID of the Subnet in which you want to create the VM group. --tag-key string The key of the tag, between 1 and 255 characters. --tag-value string The value of the tag, between 0 and 255 characters. - --vm-count int The number of VMs deployed in the VM group. - --vm-template-id string The ID of the VM template used to launch VMs in the VM group. + --vm-count int [REQUIRED] The number of VMs deployed in the VM group. + --vm-template-id string [REQUIRED] The ID of the VM template used to launch VMs in the VM group. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_vmtemplate_create.md b/docs/reference/octl_iaas_vmtemplate_create.md index 4eee42b3..2b2113c1 100644 --- a/docs/reference/octl_iaas_vmtemplate_create.md +++ b/docs/reference/octl_iaas_vmtemplate_create.md @@ -21,15 +21,15 @@ octl iaas vmtemplate create [flags] ### Options ``` - --cpu-core int The number of vCores to use for each VM. - --cpu-generation string The processor generation to use for each VM (for example, v4). + --cpu-core int [REQUIRED] The number of vCores to use for each VM. + --cpu-generation string [REQUIRED] The processor generation to use for each VM (for example, v4). --cpu-performance string The performance of the VMs. --description string A description for the VM template. -h, --help help for create - --image-id string The ID of the OMI to use for each VM. + --image-id string [REQUIRED] The ID of the OMI to use for each VM. --keypair-name string The name of the keypair to use for each VM. - --name string The name of the VM template. - --ram int The amount of RAM to use for each VM. + --name string [REQUIRED] The name of the VM template. + --ram int [REQUIRED] The amount of RAM to use for each VM. --tag-key string The key of the tag, between 1 and 255 characters. --tag-value string The value of the tag, between 0 and 255 characters. ``` diff --git a/docs/reference/octl_iaas_volume_create.md b/docs/reference/octl_iaas_volume_create.md index 123ac615..3ac75af6 100644 --- a/docs/reference/octl_iaas_volume_create.md +++ b/docs/reference/octl_iaas_volume_create.md @@ -26,7 +26,7 @@ octl iaas volume create [flags] --iops int The number of I/O operations per second (IOPS). --size int The size of the volume, in gibibytes (GiB). --snapshot-id string The ID of the snapshot from which you want to create the volume. - --subregion string The Subregion in which you want to create the volume. + --subregion string [REQUIRED] The Subregion in which you want to create the volume. --type string The type of volume you want to create (io1 | gp2 | standard). ``` diff --git a/docs/reference/octl_iaas_volume_link.md b/docs/reference/octl_iaas_volume_link.md index f4c2742c..cb5bc80d 100644 --- a/docs/reference/octl_iaas_volume_link.md +++ b/docs/reference/octl_iaas_volume_link.md @@ -17,9 +17,9 @@ octl iaas volume link volume_id [flags] ### Options ``` - --device_name string The name of the device. + --device_name string [REQUIRED] The name of the device. -h, --help help for link - --vm-id string The ID of the VM you want to attach the volume to. + --vm-id string [REQUIRED] The ID of the VM you want to attach the volume to. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_vpnconnection_create.md b/docs/reference/octl_iaas_vpnconnection_create.md index 372be148..fd2ec6a0 100644 --- a/docs/reference/octl_iaas_vpnconnection_create.md +++ b/docs/reference/octl_iaas_vpnconnection_create.md @@ -23,11 +23,11 @@ octl iaas vpnconnection create [flags] ### Options ``` - --client-gateway-id string The ID of the client gateway. - --connection-type string The type of VPN connection (always ipsec.1). + --client-gateway-id string [REQUIRED] The ID of the client gateway. + --connection-type string [REQUIRED] The type of VPN connection (always ipsec.1). -h, --help help for create --static-route-only By default or if false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). - --virtual-gateway-id string The ID of the virtual gateway. + --virtual-gateway-id string [REQUIRED] The ID of the virtual gateway. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_iaas_vpnconnectionroute_create.md b/docs/reference/octl_iaas_vpnconnectionroute_create.md index 9ecdd5e8..872c78ee 100644 --- a/docs/reference/octl_iaas_vpnconnectionroute_create.md +++ b/docs/reference/octl_iaas_vpnconnectionroute_create.md @@ -19,9 +19,9 @@ octl iaas vpnconnectionroute create [flags] ### Options ``` - --destination-ip-range string The network prefix of the route, in CIDR notation (for example, 10.12.0.0/16). + --destination-ip-range string [REQUIRED] The network prefix of the route, in CIDR notation (for example, 10.12.0.0/16). -h, --help help for create - --vpn-connection-id string The ID of the target VPN connection of the static route. + --vpn-connection-id string [REQUIRED] The ID of the target VPN connection of the static route. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_kube_cluster_create.md b/docs/reference/octl_kube_cluster_create.md index 48c6a3b9..964d6149 100644 --- a/docs/reference/octl_kube_cluster_create.md +++ b/docs/reference/octl_kube_cluster_create.md @@ -29,14 +29,14 @@ octl kube cluster create [flags] --maintenance-tz string Timezone for the maintenance window --maintenance-week-day string Day of the week for the maintenance window --multi-az Flag to enable multi-availability zone for the control plane - --name string Unique cluster name per project, must start with a letter and contain only lowercase letters, numbers, or hyphens + --name string [REQUIRED] Unique cluster name per project, must start with a letter and contain only lowercase letters, numbers, or hyphens --oidc-client-id string The client id that all tokens must be issued for. --oidc-group-claim strings --oidc-group-prefix string --oidc-issuer-url string The URL of the provider that allows the API server to discover public signing keys. --oidc-username-claim string --oidc-username-prefix string - --project string Unique identifier of the project this cluster belongs to + --project string [REQUIRED] Unique identifier of the project this cluster belongs to --quirk strings --subregions strings List of subregions where control plane components are deployed --tags stringToString (default []) diff --git a/docs/reference/octl_kube_nodepool_api.md b/docs/reference/octl_kube_nodepool_api.md index b441b102..60b0bf72 100644 --- a/docs/reference/octl_kube_nodepool_api.md +++ b/docs/reference/octl_kube_nodepool_api.md @@ -5,7 +5,7 @@ nodepool api calls ### Options ``` - --cluster string Name or ID of cluster + --cluster string [REQUIRED] Name or ID of cluster -h, --help help for api --project string Name or ID of project ``` diff --git a/docs/reference/octl_kube_nodepool_api_Create.md b/docs/reference/octl_kube_nodepool_api_Create.md index 1a9abcb9..c3398b12 100644 --- a/docs/reference/octl_kube_nodepool_api_Create.md +++ b/docs/reference/octl_kube_nodepool_api_Create.md @@ -87,7 +87,7 @@ octl kube nodepool api Create [flags] ### Options inherited from parent commands ``` - --cluster string Name or ID of cluster + --cluster string [REQUIRED] Name or ID of cluster -c, --columns string columns to display - [+]:<jq query for content>||<title>:<jq query for content> --config string Path of profile file (by default, ~/.osc/config.json) --dry-run Display the request payload that would be sent to the API without sending it diff --git a/docs/reference/octl_kube_nodepool_api_Delete.md b/docs/reference/octl_kube_nodepool_api_Delete.md index 5429784d..af1a464b 100644 --- a/docs/reference/octl_kube_nodepool_api_Delete.md +++ b/docs/reference/octl_kube_nodepool_api_Delete.md @@ -15,7 +15,7 @@ octl kube nodepool api Delete id [flags] ### Options inherited from parent commands ``` - --cluster string Name or ID of cluster + --cluster string [REQUIRED] Name or ID of cluster -c, --columns string columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content> --config string Path of profile file (by default, ~/.osc/config.json) --dry-run Display the request payload that would be sent to the API without sending it diff --git a/docs/reference/octl_kube_nodepool_api_Get.md b/docs/reference/octl_kube_nodepool_api_Get.md index 4e04ba4a..92cd342d 100644 --- a/docs/reference/octl_kube_nodepool_api_Get.md +++ b/docs/reference/octl_kube_nodepool_api_Get.md @@ -15,7 +15,7 @@ octl kube nodepool api Get id [flags] ### Options inherited from parent commands ``` - --cluster string Name or ID of cluster + --cluster string [REQUIRED] Name or ID of cluster -c, --columns string columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content> --config string Path of profile file (by default, ~/.osc/config.json) --dry-run Display the request payload that would be sent to the API without sending it diff --git a/docs/reference/octl_kube_nodepool_api_List.md b/docs/reference/octl_kube_nodepool_api_List.md index e9bb86e6..d242e19a 100644 --- a/docs/reference/octl_kube_nodepool_api_List.md +++ b/docs/reference/octl_kube_nodepool_api_List.md @@ -15,7 +15,7 @@ octl kube nodepool api List [flags] ### Options inherited from parent commands ``` - --cluster string Name or ID of cluster + --cluster string [REQUIRED] Name or ID of cluster -c, --columns string columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content> --config string Path of profile file (by default, ~/.osc/config.json) --dry-run Display the request payload that would be sent to the API without sending it diff --git a/docs/reference/octl_kube_nodepool_api_Update.md b/docs/reference/octl_kube_nodepool_api_Update.md index e8d2e461..45994502 100644 --- a/docs/reference/octl_kube_nodepool_api_Update.md +++ b/docs/reference/octl_kube_nodepool_api_Update.md @@ -87,7 +87,7 @@ octl kube nodepool api Update [flags] ### Options inherited from parent commands ``` - --cluster string Name or ID of cluster + --cluster string [REQUIRED] Name or ID of cluster -c, --columns string columns to display - [+]<title>:<jq query for content>||<title>:<jq query for content> --config string Path of profile file (by default, ~/.osc/config.json) --dry-run Display the request payload that would be sent to the API without sending it diff --git a/docs/reference/octl_kube_nodepool_create.md b/docs/reference/octl_kube_nodepool_create.md index 2f51de4c..eda23a96 100644 --- a/docs/reference/octl_kube_nodepool_create.md +++ b/docs/reference/octl_kube_nodepool_create.md @@ -18,8 +18,8 @@ octl kube nodepool create [flags] --auto-healing --auto-upgrade-enabled --autoscaling - --cluster string Name or ID of cluster - --desired-nodes int + --cluster string [REQUIRED] Name or ID of cluster + --desired-nodes int [REQUIRED] --fgpu-model string --fgpu-operator --flavour string @@ -28,10 +28,10 @@ octl kube nodepool create [flags] --ip-pool string --max-nodes int --min-nodes int - --name string + --name string [REQUIRED] --node-annotations stringToString (default []) --node-labels stringToString (default []) - --node-type string + --node-type string [REQUIRED] --placement-attract-cluster string --placement-attract-server string --placement-repulse-cluster string @@ -47,7 +47,7 @@ octl kube nodepool create [flags] --volume-size int --volume-snapshot string --volume-type string - --zones strings + --zones strings [REQUIRED] ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_kube_nodepool_delete.md b/docs/reference/octl_kube_nodepool_delete.md index 2160cd12..fb83c421 100644 --- a/docs/reference/octl_kube_nodepool_delete.md +++ b/docs/reference/octl_kube_nodepool_delete.md @@ -15,7 +15,7 @@ octl kube nodepool delete name [name]... [flags] ### Options ``` - --cluster string Name or ID of cluster + --cluster string [REQUIRED] Name or ID of cluster -h, --help help for delete ``` diff --git a/docs/reference/octl_kube_nodepool_describe.md b/docs/reference/octl_kube_nodepool_describe.md index 748bd32d..71bf9d22 100644 --- a/docs/reference/octl_kube_nodepool_describe.md +++ b/docs/reference/octl_kube_nodepool_describe.md @@ -15,7 +15,7 @@ octl kube nodepool describe name [name]... [flags] ### Options ``` - --cluster string Name or ID of cluster + --cluster string [REQUIRED] Name or ID of cluster -h, --help help for describe ``` diff --git a/docs/reference/octl_kube_nodepool_list.md b/docs/reference/octl_kube_nodepool_list.md index c9c88894..9a43c211 100644 --- a/docs/reference/octl_kube_nodepool_list.md +++ b/docs/reference/octl_kube_nodepool_list.md @@ -15,7 +15,7 @@ octl kube nodepool list [flags] ### Options ``` - --cluster string Name or ID of cluster + --cluster string [REQUIRED] Name or ID of cluster -h, --help help for list ``` diff --git a/docs/reference/octl_kube_project_create.md b/docs/reference/octl_kube_project_create.md index 5633f801..441baaf7 100644 --- a/docs/reference/octl_kube_project_create.md +++ b/docs/reference/octl_kube_project_create.md @@ -19,7 +19,7 @@ octl kube project create [flags] --description string Optional description of the project --disable-api-termination Flag to prevent accidental project deletion -h, --help help for create - --name string Unique name for the project, must start with a letter and contain only lowercase letters, numbers, or hyphens + --name string [REQUIRED] Unique name for the project, must start with a letter and contain only lowercase letters, numbers, or hyphens --quirk strings --region string Region where the project is deployed ``` diff --git a/docs/reference/octl_kube_secret.md b/docs/reference/octl_kube_secret.md index f45676e0..cab4f1d1 100644 --- a/docs/reference/octl_kube_secret.md +++ b/docs/reference/octl_kube_secret.md @@ -28,7 +28,7 @@ octl kube secret [flags] ``` -h, --help help for secret - --name string name of secret + --name string [REQUIRED] name of secret --namespace string namespace of secret (default "kube-system") ``` diff --git a/docs/reference/octl_storage_api_AbortMultipartUpload.md b/docs/reference/octl_storage_api_AbortMultipartUpload.md index fb9572d4..8666b80b 100644 --- a/docs/reference/octl_storage_api_AbortMultipartUpload.md +++ b/docs/reference/octl_storage_api_AbortMultipartUpload.md @@ -9,12 +9,12 @@ octl storage api AbortMultipartUpload [flags] ### Options ``` - --Bucket string The bucket name to which the upload was taking place. + --Bucket string [REQUIRED] The bucket name to which the upload was taking place. --ExpectedBucketOwner string The account ID of the expected bucket owner. --IfMatchInitiatedTime osctime If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp. - --Key string of the object for which the multipart upload was initiated. + --Key string [REQUIRED] of the object for which the multipart upload was initiated. --RequestPayer string Confirms that the requester knows that they will be charged for the request. - --UploadId string Upload ID that identifies the multipart upload. + --UploadId string [REQUIRED] Upload ID that identifies the multipart upload. -h, --help help for AbortMultipartUpload ``` diff --git a/docs/reference/octl_storage_api_CompleteMultipartUpload.md b/docs/reference/octl_storage_api_CompleteMultipartUpload.md index 26a1b798..dd036505 100644 --- a/docs/reference/octl_storage_api_CompleteMultipartUpload.md +++ b/docs/reference/octl_storage_api_CompleteMultipartUpload.md @@ -9,7 +9,7 @@ octl storage api CompleteMultipartUpload [flags] ### Options ``` - --Bucket string Name of the bucket to which the multipart upload was initiated. + --Bucket string [REQUIRED] Name of the bucket to which the multipart upload was initiated. --ChecksumCRC32 string This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. --ChecksumCRC32C string This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. --ChecksumSHA1 string This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. @@ -17,7 +17,7 @@ octl storage api CompleteMultipartUpload [flags] --ExpectedBucketOwner string The account ID of the expected bucket owner. --IfMatch string Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. --IfNoneMatch string Uploads the object only if the object key name does not already exist in the bucket specified. - --Key string Object key for which the multipart upload was initiated. + --Key string [REQUIRED] Object key for which the multipart upload was initiated. --MultipartUpload.Parts.0.ChecksumCRC32 string The base64-encoded, 32-bit CRC-32 checksum of the object. --MultipartUpload.Parts.0.ChecksumCRC32C string The base64-encoded, 32-bit CRC-32C checksum of the object. --MultipartUpload.Parts.0.ChecksumSHA1 string The base64-encoded, 160-bit SHA-1 digest of the object. @@ -28,7 +28,7 @@ octl storage api CompleteMultipartUpload [flags] --SSECustomerAlgorithm string The server-side encryption (SSE) algorithm used to encrypt the object. --SSECustomerKey string The server-side encryption (SSE) customer managed key. --SSECustomerKeyMD5 string The MD5 server-side encryption (SSE) customer managed key. - --UploadId string ID for the initiated multipart upload. + --UploadId string [REQUIRED] ID for the initiated multipart upload. -h, --help help for CompleteMultipartUpload ``` diff --git a/docs/reference/octl_storage_api_CopyObject.md b/docs/reference/octl_storage_api_CopyObject.md index aface05e..997db5a6 100644 --- a/docs/reference/octl_storage_api_CopyObject.md +++ b/docs/reference/octl_storage_api_CopyObject.md @@ -10,7 +10,7 @@ octl storage api CopyObject [flags] ``` --ACL string The canned access control list (ACL) to apply to the object. - --Bucket string The name of the destination bucket. + --Bucket string [REQUIRED] The name of the destination bucket. --BucketKeyEnabled Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). --CacheControl string Specifies the caching behavior along the request/reply chain. --ChecksumAlgorithm string Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. @@ -18,7 +18,7 @@ octl storage api CopyObject [flags] --ContentEncoding string Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. --ContentLanguage string The language the content is in. --ContentType string A standard MIME type that describes the format of the object data. - --CopySource string Specifies the source object for the copy operation. + --CopySource string [REQUIRED] Specifies the source object for the copy operation. --CopySourceIfMatch string Copies the object if its entity tag (ETag) matches the specified tag. --CopySourceIfModifiedSince osctime Copies the object if it has been modified since the specified time. --CopySourceIfNoneMatch string Copies the object if its entity tag (ETag) is different than the specified ETag. @@ -33,7 +33,7 @@ octl storage api CopyObject [flags] --GrantRead string Allows grantee to read the object data and its metadata. --GrantReadACP string Allows grantee to read the object ACL. --GrantWriteACP string Allows grantee to write the ACL for the applicable object. - --Key string The key of the destination object. + --Key string [REQUIRED] The key of the destination object. --Metadata stringToString A map of metadata to store with the object in S3. (default []) --MetadataDirective string Specifies whether the metadata is copied from the source object or replaced with metadata that's provided in the request. --ObjectLockLegalHoldStatus string Specifies whether you want to apply a legal hold to the object copy. diff --git a/docs/reference/octl_storage_api_CreateBucket.md b/docs/reference/octl_storage_api_CreateBucket.md index 289970ec..7c7f4c2d 100644 --- a/docs/reference/octl_storage_api_CreateBucket.md +++ b/docs/reference/octl_storage_api_CreateBucket.md @@ -10,7 +10,7 @@ octl storage api CreateBucket [flags] ``` --ACL string The canned ACL to apply to the bucket. - --Bucket string The name of the bucket to create. + --Bucket string [REQUIRED] The name of the bucket to create. --CreateBucketConfiguration.Bucket.DataRedundancy string The number of Zone (Availability Zone or Local Zone) that's used for redundancy for the bucket. --CreateBucketConfiguration.Bucket.Type string The type of bucket. --CreateBucketConfiguration.Location.Name string The name of the location where the bucket will be created. diff --git a/docs/reference/octl_storage_api_CreateMultipartUpload.md b/docs/reference/octl_storage_api_CreateMultipartUpload.md index 97d148d1..60584d52 100644 --- a/docs/reference/octl_storage_api_CreateMultipartUpload.md +++ b/docs/reference/octl_storage_api_CreateMultipartUpload.md @@ -10,7 +10,7 @@ octl storage api CreateMultipartUpload [flags] ``` --ACL string The canned ACL to apply to the object. - --Bucket string The name of the bucket where the multipart upload is initiated and where the object is uploaded. + --Bucket string [REQUIRED] The name of the bucket where the multipart upload is initiated and where the object is uploaded. --BucketKeyEnabled Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). --CacheControl string Specifies caching behavior along the request/reply chain. --ChecksumAlgorithm string Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. @@ -24,7 +24,7 @@ octl storage api CreateMultipartUpload [flags] --GrantRead string Specify access permissions explicitly to allow grantee to read the object data and its metadata. --GrantReadACP string Specify access permissions explicitly to allows grantee to read the object ACL. --GrantWriteACP string Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object. - --Key string Object key for which the multipart upload is to be initiated. + --Key string [REQUIRED] Object key for which the multipart upload is to be initiated. --Metadata stringToString A map of metadata to store with the object in S3. (default []) --ObjectLockLegalHoldStatus string Specifies whether you want to apply a legal hold to the uploaded object. --ObjectLockMode string Specifies the Object Lock mode that you want to apply to the uploaded object. diff --git a/docs/reference/octl_storage_api_DeleteBucket.md b/docs/reference/octl_storage_api_DeleteBucket.md index 2fe5896f..3fb925c4 100644 --- a/docs/reference/octl_storage_api_DeleteBucket.md +++ b/docs/reference/octl_storage_api_DeleteBucket.md @@ -9,7 +9,7 @@ octl storage api DeleteBucket [flags] ### Options ``` - --Bucket string Specifies the bucket being deleted. + --Bucket string [REQUIRED] Specifies the bucket being deleted. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for DeleteBucket ``` diff --git a/docs/reference/octl_storage_api_DeleteBucketCors.md b/docs/reference/octl_storage_api_DeleteBucketCors.md index 396d39b6..4bd38624 100644 --- a/docs/reference/octl_storage_api_DeleteBucketCors.md +++ b/docs/reference/octl_storage_api_DeleteBucketCors.md @@ -9,7 +9,7 @@ octl storage api DeleteBucketCors [flags] ### Options ``` - --Bucket string Specifies the bucket whose cors configuration is being deleted. + --Bucket string [REQUIRED] Specifies the bucket whose cors configuration is being deleted. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for DeleteBucketCors ``` diff --git a/docs/reference/octl_storage_api_DeleteBucketEncryption.md b/docs/reference/octl_storage_api_DeleteBucketEncryption.md index 5c4ca5b1..ca576a8a 100644 --- a/docs/reference/octl_storage_api_DeleteBucketEncryption.md +++ b/docs/reference/octl_storage_api_DeleteBucketEncryption.md @@ -9,7 +9,7 @@ octl storage api DeleteBucketEncryption [flags] ### Options ``` - --Bucket string The name of the bucket containing the server-side encryption configuration to delete. + --Bucket string [REQUIRED] The name of the bucket containing the server-side encryption configuration to delete. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for DeleteBucketEncryption ``` diff --git a/docs/reference/octl_storage_api_DeleteBucketLifecycle.md b/docs/reference/octl_storage_api_DeleteBucketLifecycle.md index 793241f3..81556bf5 100644 --- a/docs/reference/octl_storage_api_DeleteBucketLifecycle.md +++ b/docs/reference/octl_storage_api_DeleteBucketLifecycle.md @@ -9,7 +9,7 @@ octl storage api DeleteBucketLifecycle [flags] ### Options ``` - --Bucket string The bucket name of the lifecycle to delete. + --Bucket string [REQUIRED] The bucket name of the lifecycle to delete. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for DeleteBucketLifecycle ``` diff --git a/docs/reference/octl_storage_api_DeleteBucketPolicy.md b/docs/reference/octl_storage_api_DeleteBucketPolicy.md index 51a41e80..4e30a5d0 100644 --- a/docs/reference/octl_storage_api_DeleteBucketPolicy.md +++ b/docs/reference/octl_storage_api_DeleteBucketPolicy.md @@ -9,7 +9,7 @@ octl storage api DeleteBucketPolicy [flags] ### Options ``` - --Bucket string The bucket name. + --Bucket string [REQUIRED] The bucket name. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for DeleteBucketPolicy ``` diff --git a/docs/reference/octl_storage_api_DeleteBucketWebsite.md b/docs/reference/octl_storage_api_DeleteBucketWebsite.md index 65fc8294..1eadfc2e 100644 --- a/docs/reference/octl_storage_api_DeleteBucketWebsite.md +++ b/docs/reference/octl_storage_api_DeleteBucketWebsite.md @@ -9,7 +9,7 @@ octl storage api DeleteBucketWebsite [flags] ### Options ``` - --Bucket string The bucket name for which you want to remove the website configuration. + --Bucket string [REQUIRED] The bucket name for which you want to remove the website configuration. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for DeleteBucketWebsite ``` diff --git a/docs/reference/octl_storage_api_DeleteObject.md b/docs/reference/octl_storage_api_DeleteObject.md index 47dd74af..28a296af 100644 --- a/docs/reference/octl_storage_api_DeleteObject.md +++ b/docs/reference/octl_storage_api_DeleteObject.md @@ -9,13 +9,13 @@ octl storage api DeleteObject [flags] ### Options ``` - --Bucket string The bucket name of the bucket containing the object. + --Bucket string [REQUIRED] The bucket name of the bucket containing the object. --BypassGovernanceRetention Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. --ExpectedBucketOwner string The account ID of the expected bucket owner. --IfMatch string The If-Match header field makes the request method conditional on ETags. --IfMatchLastModifiedTime osctime If present, the object is deleted only if its modification times matches the provided Timestamp . --IfMatchSize int If present, the object is deleted only if its size matches the provided size in bytes. - --Key string name of the object to delete. + --Key string [REQUIRED] name of the object to delete. --MFA string The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. --RequestPayer string Confirms that the requester knows that they will be charged for the request. --VersionId string Version ID used to reference a specific version of the object. diff --git a/docs/reference/octl_storage_api_DeleteObjectTagging.md b/docs/reference/octl_storage_api_DeleteObjectTagging.md index 88e1e8d5..90587678 100644 --- a/docs/reference/octl_storage_api_DeleteObjectTagging.md +++ b/docs/reference/octl_storage_api_DeleteObjectTagging.md @@ -9,9 +9,9 @@ octl storage api DeleteObjectTagging [flags] ### Options ``` - --Bucket string The bucket name containing the objects from which to remove the tags. + --Bucket string [REQUIRED] The bucket name containing the objects from which to remove the tags. --ExpectedBucketOwner string The account ID of the expected bucket owner. - --Key string The key that identifies the object in the bucket from which to remove all tags. + --Key string [REQUIRED] The key that identifies the object in the bucket from which to remove all tags. --VersionId string The versionId of the object that the tag-set will be removed from. -h, --help help for DeleteObjectTagging ``` diff --git a/docs/reference/octl_storage_api_GetBucketAcl.md b/docs/reference/octl_storage_api_GetBucketAcl.md index c25ad061..ac5fc4f2 100644 --- a/docs/reference/octl_storage_api_GetBucketAcl.md +++ b/docs/reference/octl_storage_api_GetBucketAcl.md @@ -9,7 +9,7 @@ octl storage api GetBucketAcl [flags] ### Options ``` - --Bucket string Specifies the S3 bucket whose ACL is being requested. + --Bucket string [REQUIRED] Specifies the S3 bucket whose ACL is being requested. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for GetBucketAcl ``` diff --git a/docs/reference/octl_storage_api_GetBucketCors.md b/docs/reference/octl_storage_api_GetBucketCors.md index 0decb58c..cbf2febd 100644 --- a/docs/reference/octl_storage_api_GetBucketCors.md +++ b/docs/reference/octl_storage_api_GetBucketCors.md @@ -9,7 +9,7 @@ octl storage api GetBucketCors [flags] ### Options ``` - --Bucket string The bucket name for which to get the cors configuration. + --Bucket string [REQUIRED] The bucket name for which to get the cors configuration. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for GetBucketCors ``` diff --git a/docs/reference/octl_storage_api_GetBucketEncryption.md b/docs/reference/octl_storage_api_GetBucketEncryption.md index de238782..92d3abb1 100644 --- a/docs/reference/octl_storage_api_GetBucketEncryption.md +++ b/docs/reference/octl_storage_api_GetBucketEncryption.md @@ -9,7 +9,7 @@ octl storage api GetBucketEncryption [flags] ### Options ``` - --Bucket string The name of the bucket from which the server-side encryption configuration is retrieved. + --Bucket string [REQUIRED] The name of the bucket from which the server-side encryption configuration is retrieved. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for GetBucketEncryption ``` diff --git a/docs/reference/octl_storage_api_GetBucketLifecycleConfiguration.md b/docs/reference/octl_storage_api_GetBucketLifecycleConfiguration.md index b5e8b508..c2125160 100644 --- a/docs/reference/octl_storage_api_GetBucketLifecycleConfiguration.md +++ b/docs/reference/octl_storage_api_GetBucketLifecycleConfiguration.md @@ -9,7 +9,7 @@ octl storage api GetBucketLifecycleConfiguration [flags] ### Options ``` - --Bucket string The name of the bucket for which to get the lifecycle information. + --Bucket string [REQUIRED] The name of the bucket for which to get the lifecycle information. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for GetBucketLifecycleConfiguration ``` diff --git a/docs/reference/octl_storage_api_GetBucketLocation.md b/docs/reference/octl_storage_api_GetBucketLocation.md index 38774444..55c69974 100644 --- a/docs/reference/octl_storage_api_GetBucketLocation.md +++ b/docs/reference/octl_storage_api_GetBucketLocation.md @@ -9,7 +9,7 @@ octl storage api GetBucketLocation [flags] ### Options ``` - --Bucket string The name of the bucket for which to get the location. + --Bucket string [REQUIRED] The name of the bucket for which to get the location. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for GetBucketLocation ``` diff --git a/docs/reference/octl_storage_api_GetBucketPolicy.md b/docs/reference/octl_storage_api_GetBucketPolicy.md index c59bf19c..89d1d930 100644 --- a/docs/reference/octl_storage_api_GetBucketPolicy.md +++ b/docs/reference/octl_storage_api_GetBucketPolicy.md @@ -9,7 +9,7 @@ octl storage api GetBucketPolicy [flags] ### Options ``` - --Bucket string The bucket name to get the bucket policy for. + --Bucket string [REQUIRED] The bucket name to get the bucket policy for. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for GetBucketPolicy ``` diff --git a/docs/reference/octl_storage_api_GetBucketVersioning.md b/docs/reference/octl_storage_api_GetBucketVersioning.md index ebfc2d05..7dd17cfa 100644 --- a/docs/reference/octl_storage_api_GetBucketVersioning.md +++ b/docs/reference/octl_storage_api_GetBucketVersioning.md @@ -9,7 +9,7 @@ octl storage api GetBucketVersioning [flags] ### Options ``` - --Bucket string The name of the bucket for which to get the versioning information. + --Bucket string [REQUIRED] The name of the bucket for which to get the versioning information. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for GetBucketVersioning ``` diff --git a/docs/reference/octl_storage_api_GetBucketWebsite.md b/docs/reference/octl_storage_api_GetBucketWebsite.md index d1a39e0c..91373176 100644 --- a/docs/reference/octl_storage_api_GetBucketWebsite.md +++ b/docs/reference/octl_storage_api_GetBucketWebsite.md @@ -9,7 +9,7 @@ octl storage api GetBucketWebsite [flags] ### Options ``` - --Bucket string The bucket name for which to get the website configuration. + --Bucket string [REQUIRED] The bucket name for which to get the website configuration. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for GetBucketWebsite ``` diff --git a/docs/reference/octl_storage_api_GetObject.md b/docs/reference/octl_storage_api_GetObject.md index 2aa381de..54742142 100644 --- a/docs/reference/octl_storage_api_GetObject.md +++ b/docs/reference/octl_storage_api_GetObject.md @@ -9,14 +9,14 @@ octl storage api GetObject [flags] ### Options ``` - --Bucket string The bucket name containing the object. + --Bucket string [REQUIRED] The bucket name containing the object. --ChecksumMode string To retrieve the checksum, this mode must be enabled. --ExpectedBucketOwner string The account ID of the expected bucket owner. --IfMatch string Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed error. --IfModifiedSince osctime Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified error. --IfNoneMatch string Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified error. --IfUnmodifiedSince osctime Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed error. - --Key string of the object to get. + --Key string [REQUIRED] of the object to get. --PartNumber int32 Part number of the object being read. --Range string Downloads the specified byte range of an object. --RequestPayer string Confirms that the requester knows that they will be charged for the request. diff --git a/docs/reference/octl_storage_api_GetObjectAcl.md b/docs/reference/octl_storage_api_GetObjectAcl.md index e091a238..05cc506a 100644 --- a/docs/reference/octl_storage_api_GetObjectAcl.md +++ b/docs/reference/octl_storage_api_GetObjectAcl.md @@ -9,9 +9,9 @@ octl storage api GetObjectAcl [flags] ### Options ``` - --Bucket string The bucket name that contains the object for which to get the ACL information. + --Bucket string [REQUIRED] The bucket name that contains the object for which to get the ACL information. --ExpectedBucketOwner string The account ID of the expected bucket owner. - --Key string The key of the object for which to get the ACL information. + --Key string [REQUIRED] The key of the object for which to get the ACL information. --RequestPayer string Confirms that the requester knows that they will be charged for the request. --VersionId string Version ID used to reference a specific version of the object. -h, --help help for GetObjectAcl diff --git a/docs/reference/octl_storage_api_GetObjectLockConfiguration.md b/docs/reference/octl_storage_api_GetObjectLockConfiguration.md index 6a023c83..fb6e43ac 100644 --- a/docs/reference/octl_storage_api_GetObjectLockConfiguration.md +++ b/docs/reference/octl_storage_api_GetObjectLockConfiguration.md @@ -9,7 +9,7 @@ octl storage api GetObjectLockConfiguration [flags] ### Options ``` - --Bucket string The bucket whose Object Lock configuration you want to retrieve. + --Bucket string [REQUIRED] The bucket whose Object Lock configuration you want to retrieve. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for GetObjectLockConfiguration ``` diff --git a/docs/reference/octl_storage_api_GetObjectRetention.md b/docs/reference/octl_storage_api_GetObjectRetention.md index 26179a3e..e5896e2e 100644 --- a/docs/reference/octl_storage_api_GetObjectRetention.md +++ b/docs/reference/octl_storage_api_GetObjectRetention.md @@ -9,9 +9,9 @@ octl storage api GetObjectRetention [flags] ### Options ``` - --Bucket string The bucket name containing the object whose retention settings you want to retrieve. + --Bucket string [REQUIRED] The bucket name containing the object whose retention settings you want to retrieve. --ExpectedBucketOwner string The account ID of the expected bucket owner. - --Key string The key name for the object whose retention settings you want to retrieve. + --Key string [REQUIRED] The key name for the object whose retention settings you want to retrieve. --RequestPayer string Confirms that the requester knows that they will be charged for the request. --VersionId string The version ID for the object whose retention settings you want to retrieve. -h, --help help for GetObjectRetention diff --git a/docs/reference/octl_storage_api_GetObjectTagging.md b/docs/reference/octl_storage_api_GetObjectTagging.md index cc2daef2..58935ff8 100644 --- a/docs/reference/octl_storage_api_GetObjectTagging.md +++ b/docs/reference/octl_storage_api_GetObjectTagging.md @@ -9,9 +9,9 @@ octl storage api GetObjectTagging [flags] ### Options ``` - --Bucket string The bucket name containing the object for which to get the tagging information. + --Bucket string [REQUIRED] The bucket name containing the object for which to get the tagging information. --ExpectedBucketOwner string The account ID of the expected bucket owner. - --Key string Object key for which to get the tagging information. + --Key string [REQUIRED] Object key for which to get the tagging information. --RequestPayer string Confirms that the requester knows that they will be charged for the request. --VersionId string The versionId of the object for which to get the tagging information. -h, --help help for GetObjectTagging diff --git a/docs/reference/octl_storage_api_HeadBucket.md b/docs/reference/octl_storage_api_HeadBucket.md index 0adda090..016b5ef1 100644 --- a/docs/reference/octl_storage_api_HeadBucket.md +++ b/docs/reference/octl_storage_api_HeadBucket.md @@ -9,7 +9,7 @@ octl storage api HeadBucket [flags] ### Options ``` - --Bucket string The bucket name. + --Bucket string [REQUIRED] The bucket name. --ExpectedBucketOwner string The account ID of the expected bucket owner. -h, --help help for HeadBucket ``` diff --git a/docs/reference/octl_storage_api_HeadObject.md b/docs/reference/octl_storage_api_HeadObject.md index a8aa96e5..e0423799 100644 --- a/docs/reference/octl_storage_api_HeadObject.md +++ b/docs/reference/octl_storage_api_HeadObject.md @@ -9,14 +9,14 @@ octl storage api HeadObject [flags] ### Options ``` - --Bucket string The name of the bucket that contains the object. + --Bucket string [REQUIRED] The name of the bucket that contains the object. --ChecksumMode string To retrieve the checksum, this parameter must be enabled. --ExpectedBucketOwner string The account ID of the expected bucket owner. --IfMatch string Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error. --IfModifiedSince osctime Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error. --IfNoneMatch string Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error. --IfUnmodifiedSince osctime Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error. - --Key string The object key. + --Key string [REQUIRED] The object key. --PartNumber int32 Part number of the object being read. --Range string HeadObject returns only the metadata for an object. --RequestPayer string Confirms that the requester knows that they will be charged for the request. diff --git a/docs/reference/octl_storage_api_ListMultipartUploads.md b/docs/reference/octl_storage_api_ListMultipartUploads.md index f45b0e95..0361bdde 100644 --- a/docs/reference/octl_storage_api_ListMultipartUploads.md +++ b/docs/reference/octl_storage_api_ListMultipartUploads.md @@ -9,7 +9,7 @@ octl storage api ListMultipartUploads [flags] ### Options ``` - --Bucket string The name of the bucket to which the multipart upload was initiated. + --Bucket string [REQUIRED] The name of the bucket to which the multipart upload was initiated. --Delimiter string Character you use to group keys. --EncodingType string Encoding type used by Amazon S3 to encode the [object keys] in the response. --ExpectedBucketOwner string The account ID of the expected bucket owner. diff --git a/docs/reference/octl_storage_api_ListObjectVersions.md b/docs/reference/octl_storage_api_ListObjectVersions.md index 2f9c3585..caeebce2 100644 --- a/docs/reference/octl_storage_api_ListObjectVersions.md +++ b/docs/reference/octl_storage_api_ListObjectVersions.md @@ -9,7 +9,7 @@ octl storage api ListObjectVersions [flags] ### Options ``` - --Bucket string The bucket name that contains the objects. + --Bucket string [REQUIRED] The bucket name that contains the objects. --Delimiter string A delimiter is a character that you specify to group keys. --EncodingType string Encoding type used by Amazon S3 to encode the [object keys] in the response. --ExpectedBucketOwner string The account ID of the expected bucket owner. diff --git a/docs/reference/octl_storage_api_ListObjectsV2.md b/docs/reference/octl_storage_api_ListObjectsV2.md index 32e14db5..9083a838 100644 --- a/docs/reference/octl_storage_api_ListObjectsV2.md +++ b/docs/reference/octl_storage_api_ListObjectsV2.md @@ -9,7 +9,7 @@ octl storage api ListObjectsV2 [flags] ### Options ``` - --Bucket string Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com . + --Bucket string [REQUIRED] Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com . --ContinuationToken string indicates to Amazon S3 that the list is being continued on this bucket with a token. --Delimiter string A delimiter is a character that you use to group keys. --EncodingType string Encoding type used by Amazon S3 to encode the [object keys] in the response. diff --git a/docs/reference/octl_storage_api_ListParts.md b/docs/reference/octl_storage_api_ListParts.md index a5c64bdb..75e13809 100644 --- a/docs/reference/octl_storage_api_ListParts.md +++ b/docs/reference/octl_storage_api_ListParts.md @@ -9,16 +9,16 @@ octl storage api ListParts [flags] ### Options ``` - --Bucket string The name of the bucket to which the parts are being uploaded. + --Bucket string [REQUIRED] The name of the bucket to which the parts are being uploaded. --ExpectedBucketOwner string The account ID of the expected bucket owner. - --Key string Object key for which the multipart upload was initiated. + --Key string [REQUIRED] Object key for which the multipart upload was initiated. --MaxParts int32 Sets the maximum number of parts to return. --PartNumberMarker string Specifies the part after which listing should begin. --RequestPayer string Confirms that the requester knows that they will be charged for the request. --SSECustomerAlgorithm string The server-side encryption (SSE) algorithm used to encrypt the object. --SSECustomerKey string The server-side encryption (SSE) customer managed key. --SSECustomerKeyMD5 string The MD5 server-side encryption (SSE) customer managed key. - --UploadId string Upload ID identifying the multipart upload whose parts are being listed. + --UploadId string [REQUIRED] Upload ID identifying the multipart upload whose parts are being listed. -h, --help help for ListParts ``` diff --git a/docs/reference/octl_storage_api_PutBucketAcl.md b/docs/reference/octl_storage_api_PutBucketAcl.md index ba8448fc..b0442e0c 100644 --- a/docs/reference/octl_storage_api_PutBucketAcl.md +++ b/docs/reference/octl_storage_api_PutBucketAcl.md @@ -13,12 +13,12 @@ octl storage api PutBucketAcl [flags] --AccessControlPolicy.Grants.0.Grantee.DisplayName string Screen name of the grantee. --AccessControlPolicy.Grants.0.Grantee.EmailAddress string Email address of the grantee. --AccessControlPolicy.Grants.0.Grantee.ID string The canonical user ID of the grantee. - --AccessControlPolicy.Grants.0.Grantee.Type string of grantee This member is required. + --AccessControlPolicy.Grants.0.Grantee.Type string [REQUIRED] of grantee This member is required. --AccessControlPolicy.Grants.0.Grantee.URI string of the grantee group. --AccessControlPolicy.Grants.0.Permission string Specifies the permission given to the grantee. --AccessControlPolicy.Owner.DisplayName string Container for the display name of the owner. --AccessControlPolicy.Owner.ID string Container for the ID of the owner. - --Bucket string The bucket to which to apply the ACL. + --Bucket string [REQUIRED] The bucket to which to apply the ACL. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. --ContentMD5 string The base64-encoded 128-bit MD5 digest of the data. --ExpectedBucketOwner string The account ID of the expected bucket owner. diff --git a/docs/reference/octl_storage_api_PutBucketCors.md b/docs/reference/octl_storage_api_PutBucketCors.md index a98e4df1..a28a24ab 100644 --- a/docs/reference/octl_storage_api_PutBucketCors.md +++ b/docs/reference/octl_storage_api_PutBucketCors.md @@ -9,10 +9,10 @@ octl storage api PutBucketCors [flags] ### Options ``` - --Bucket string Specifies the bucket impacted by the cors configuration. + --Bucket string [REQUIRED] Specifies the bucket impacted by the cors configuration. --CORSConfiguration.CORSRules.0.AllowedHeaders strings Headers that are specified in the Access-Control-Request-Headers header. - --CORSConfiguration.CORSRules.0.AllowedMethods strings An HTTP method that you allow the origin to execute. - --CORSConfiguration.CORSRules.0.AllowedOrigins strings One or more origins you want customers to be able to access the bucket from. + --CORSConfiguration.CORSRules.0.AllowedMethods strings [REQUIRED] An HTTP method that you allow the origin to execute. + --CORSConfiguration.CORSRules.0.AllowedOrigins strings [REQUIRED] One or more origins you want customers to be able to access the bucket from. --CORSConfiguration.CORSRules.0.ExposeHeaders strings One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object). --CORSConfiguration.CORSRules.0.ID string Unique identifier for the rule. --CORSConfiguration.CORSRules.0.MaxAgeSeconds int32 The time in seconds that your browser is to cache the preflight response for the specified resource. diff --git a/docs/reference/octl_storage_api_PutBucketEncryption.md b/docs/reference/octl_storage_api_PutBucketEncryption.md index 7bc800d6..49beb3e1 100644 --- a/docs/reference/octl_storage_api_PutBucketEncryption.md +++ b/docs/reference/octl_storage_api_PutBucketEncryption.md @@ -9,12 +9,12 @@ octl storage api PutBucketEncryption [flags] ### Options ``` - --Bucket string Specifies default encryption for a bucket using server-side encryption with different key options. + --Bucket string [REQUIRED] Specifies default encryption for a bucket using server-side encryption with different key options. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. --ContentMD5 string The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. --ExpectedBucketOwner string The account ID of the expected bucket owner. --ServerSideEncryptionConfiguration.Rules.0.ApplyServerSideEncryptionByDefault.KMSMasterKeyID string Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the default encryption. - --ServerSideEncryptionConfiguration.Rules.0.ApplyServerSideEncryptionByDefault.SSEAlgorithm string Server-side encryption algorithm to use for the default encryption. + --ServerSideEncryptionConfiguration.Rules.0.ApplyServerSideEncryptionByDefault.SSEAlgorithm string [REQUIRED] Server-side encryption algorithm to use for the default encryption. --ServerSideEncryptionConfiguration.Rules.0.BucketKeyEnabled Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. -h, --help help for PutBucketEncryption ``` diff --git a/docs/reference/octl_storage_api_PutBucketLifecycleConfiguration.md b/docs/reference/octl_storage_api_PutBucketLifecycleConfiguration.md index 5578e6d6..892db843 100644 --- a/docs/reference/octl_storage_api_PutBucketLifecycleConfiguration.md +++ b/docs/reference/octl_storage_api_PutBucketLifecycleConfiguration.md @@ -9,7 +9,7 @@ octl storage api PutBucketLifecycleConfiguration [flags] ### Options ``` - --Bucket string The name of the bucket for which to set the configuration. + --Bucket string [REQUIRED] The name of the bucket for which to set the configuration. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. --ExpectedBucketOwner string The account ID of the expected bucket owner. --LifecycleConfiguration.Rules.0.AbortIncompleteMultipartUpload.DaysAfterInitiation int32 Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload. @@ -19,13 +19,13 @@ octl storage api PutBucketLifecycleConfiguration [flags] --LifecycleConfiguration.Rules.0.Filter.And.ObjectSizeGreaterThan int Minimum object size to which the rule applies. --LifecycleConfiguration.Rules.0.Filter.And.ObjectSizeLessThan int Maximum object size to which the rule applies. --LifecycleConfiguration.Rules.0.Filter.And.Prefix string identifying one or more objects to which the rule applies. - --LifecycleConfiguration.Rules.0.Filter.And.Tags.0.Key string Name of the object key. - --LifecycleConfiguration.Rules.0.Filter.And.Tags.0.Value string of the tag. + --LifecycleConfiguration.Rules.0.Filter.And.Tags.0.Key string [REQUIRED] Name of the object key. + --LifecycleConfiguration.Rules.0.Filter.And.Tags.0.Value string [REQUIRED] of the tag. --LifecycleConfiguration.Rules.0.Filter.ObjectSizeGreaterThan int Minimum object size to which the rule applies. --LifecycleConfiguration.Rules.0.Filter.ObjectSizeLessThan int Maximum object size to which the rule applies. --LifecycleConfiguration.Rules.0.Filter.Prefix string identifying one or more objects to which the rule applies. - --LifecycleConfiguration.Rules.0.Filter.Tag.Key string Name of the object key. - --LifecycleConfiguration.Rules.0.Filter.Tag.Value string of the tag. + --LifecycleConfiguration.Rules.0.Filter.Tag.Key string [REQUIRED] Name of the object key. + --LifecycleConfiguration.Rules.0.Filter.Tag.Value string [REQUIRED] of the tag. --LifecycleConfiguration.Rules.0.ID string Unique identifier for the rule. --LifecycleConfiguration.Rules.0.NoncurrentVersionExpiration.NewerNoncurrentVersions int32 Specifies how many noncurrent versions Amazon S3 will retain. --LifecycleConfiguration.Rules.0.NoncurrentVersionExpiration.NoncurrentDays int32 Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. @@ -33,7 +33,7 @@ octl storage api PutBucketLifecycleConfiguration [flags] --LifecycleConfiguration.Rules.0.NoncurrentVersionTransitions.0.NoncurrentDays int32 Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. --LifecycleConfiguration.Rules.0.NoncurrentVersionTransitions.0.StorageClass string The class of storage used to store the object. --LifecycleConfiguration.Rules.0.Prefix string identifying one or more objects to which the rule applies. - --LifecycleConfiguration.Rules.0.Status string If 'Enabled', the rule is currently being applied. + --LifecycleConfiguration.Rules.0.Status string [REQUIRED] If 'Enabled', the rule is currently being applied. --LifecycleConfiguration.Rules.0.Transitions.0.Date osctime Indicates when objects are transitioned to the specified storage class. --LifecycleConfiguration.Rules.0.Transitions.0.Days int32 Indicates the number of days after creation when objects are transitioned to the specified storage class. --LifecycleConfiguration.Rules.0.Transitions.0.StorageClass string The storage class to which you want the object to transition. diff --git a/docs/reference/octl_storage_api_PutBucketPolicy.md b/docs/reference/octl_storage_api_PutBucketPolicy.md index a20da7af..f4f39060 100644 --- a/docs/reference/octl_storage_api_PutBucketPolicy.md +++ b/docs/reference/octl_storage_api_PutBucketPolicy.md @@ -9,12 +9,12 @@ octl storage api PutBucketPolicy [flags] ### Options ``` - --Bucket string The name of the bucket. + --Bucket string [REQUIRED] The name of the bucket. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. --ConfirmRemoveSelfBucketAccess Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future. --ContentMD5 string The MD5 hash of the request body. --ExpectedBucketOwner string The account ID of the expected bucket owner. - --Policy string The bucket policy as a JSON document. + --Policy string [REQUIRED] The bucket policy as a JSON document. -h, --help help for PutBucketPolicy ``` diff --git a/docs/reference/octl_storage_api_PutBucketVersioning.md b/docs/reference/octl_storage_api_PutBucketVersioning.md index c308bb92..317d2c63 100644 --- a/docs/reference/octl_storage_api_PutBucketVersioning.md +++ b/docs/reference/octl_storage_api_PutBucketVersioning.md @@ -9,7 +9,7 @@ octl storage api PutBucketVersioning [flags] ### Options ``` - --Bucket string The bucket name. + --Bucket string [REQUIRED] The bucket name. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. --ContentMD5 string >The base64-encoded 128-bit MD5 digest of the data. --ExpectedBucketOwner string The account ID of the expected bucket owner. diff --git a/docs/reference/octl_storage_api_PutBucketWebsite.md b/docs/reference/octl_storage_api_PutBucketWebsite.md index 31fe74fd..e63badd1 100644 --- a/docs/reference/octl_storage_api_PutBucketWebsite.md +++ b/docs/reference/octl_storage_api_PutBucketWebsite.md @@ -9,13 +9,13 @@ octl storage api PutBucketWebsite [flags] ### Options ``` - --Bucket string The bucket name. + --Bucket string [REQUIRED] The bucket name. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. --ContentMD5 string The base64-encoded 128-bit MD5 digest of the data. --ExpectedBucketOwner string The account ID of the expected bucket owner. - --WebsiteConfiguration.ErrorDocument.Key string The object key name to use when a 4XX class error occurs. - --WebsiteConfiguration.IndexDocument.Suffix string A suffix that is appended to a request that is for a directory on the website endpoint. - --WebsiteConfiguration.RedirectAllRequestsTo.HostName string Name of the host where requests are redirected. + --WebsiteConfiguration.ErrorDocument.Key string [REQUIRED] The object key name to use when a 4XX class error occurs. + --WebsiteConfiguration.IndexDocument.Suffix string [REQUIRED] A suffix that is appended to a request that is for a directory on the website endpoint. + --WebsiteConfiguration.RedirectAllRequestsTo.HostName string [REQUIRED] Name of the host where requests are redirected. --WebsiteConfiguration.RedirectAllRequestsTo.Protocol string to use when redirecting requests. --WebsiteConfiguration.RoutingRules.0.Condition.HttpErrorCodeReturnedEquals string The HTTP error code when the redirect is applied. --WebsiteConfiguration.RoutingRules.0.Condition.KeyPrefixEquals string The object key name prefix when the redirect is applied. diff --git a/docs/reference/octl_storage_api_PutObject.md b/docs/reference/octl_storage_api_PutObject.md index 3516bed4..85c28d10 100644 --- a/docs/reference/octl_storage_api_PutObject.md +++ b/docs/reference/octl_storage_api_PutObject.md @@ -11,7 +11,7 @@ octl storage api PutObject [flags] ``` --ACL string The canned ACL to apply to the object. --Body streamedFile Object data. - --Bucket string The bucket name to which the PUT action was initiated. + --Bucket string [REQUIRED] The bucket name to which the PUT action was initiated. --BucketKeyEnabled Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). --CacheControl string Can be used to specify caching behavior along the request/reply chain. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. @@ -33,7 +33,7 @@ octl storage api PutObject [flags] --GrantWriteACP string Allows grantee to write the ACL for the applicable object. --IfMatch string Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. --IfNoneMatch string Uploads the object only if the object key name does not already exist in the bucket specified. - --Key string Object key for which the PUT action was initiated. + --Key string [REQUIRED] Object key for which the PUT action was initiated. --Metadata stringToString A map of metadata to store with the object in S3. (default []) --ObjectLockLegalHoldStatus string Specifies whether a legal hold will be applied to this object. --ObjectLockMode string The Object Lock mode that you want to apply to this object. diff --git a/docs/reference/octl_storage_api_PutObjectAcl.md b/docs/reference/octl_storage_api_PutObjectAcl.md index 65c33928..21e14b78 100644 --- a/docs/reference/octl_storage_api_PutObjectAcl.md +++ b/docs/reference/octl_storage_api_PutObjectAcl.md @@ -13,12 +13,12 @@ octl storage api PutObjectAcl [flags] --AccessControlPolicy.Grants.0.Grantee.DisplayName string Screen name of the grantee. --AccessControlPolicy.Grants.0.Grantee.EmailAddress string Email address of the grantee. --AccessControlPolicy.Grants.0.Grantee.ID string The canonical user ID of the grantee. - --AccessControlPolicy.Grants.0.Grantee.Type string of grantee This member is required. + --AccessControlPolicy.Grants.0.Grantee.Type string [REQUIRED] of grantee This member is required. --AccessControlPolicy.Grants.0.Grantee.URI string of the grantee group. --AccessControlPolicy.Grants.0.Permission string Specifies the permission given to the grantee. --AccessControlPolicy.Owner.DisplayName string Container for the display name of the owner. --AccessControlPolicy.Owner.ID string Container for the ID of the owner. - --Bucket string The bucket name that contains the object to which you want to attach the ACL. + --Bucket string [REQUIRED] The bucket name that contains the object to which you want to attach the ACL. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. --ContentMD5 string The base64-encoded 128-bit MD5 digest of the data. --ExpectedBucketOwner string The account ID of the expected bucket owner. @@ -27,7 +27,7 @@ octl storage api PutObjectAcl [flags] --GrantReadACP string Allows grantee to read the bucket ACL. --GrantWrite string Allows grantee to create new objects in the bucket. --GrantWriteACP string Allows grantee to write the ACL for the applicable bucket. - --Key string for which the PUT action was initiated. + --Key string [REQUIRED] for which the PUT action was initiated. --RequestPayer string Confirms that the requester knows that they will be charged for the request. --VersionId string Version ID used to reference a specific version of the object. -h, --help help for PutObjectAcl diff --git a/docs/reference/octl_storage_api_PutObjectLockConfiguration.md b/docs/reference/octl_storage_api_PutObjectLockConfiguration.md index a9afcf87..ce7758e5 100644 --- a/docs/reference/octl_storage_api_PutObjectLockConfiguration.md +++ b/docs/reference/octl_storage_api_PutObjectLockConfiguration.md @@ -9,7 +9,7 @@ octl storage api PutObjectLockConfiguration [flags] ### Options ``` - --Bucket string The bucket whose Object Lock configuration you want to create or replace. + --Bucket string [REQUIRED] The bucket whose Object Lock configuration you want to create or replace. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. --ContentMD5 string The MD5 hash for the request body. --ExpectedBucketOwner string The account ID of the expected bucket owner. diff --git a/docs/reference/octl_storage_api_PutObjectRetention.md b/docs/reference/octl_storage_api_PutObjectRetention.md index 39b72200..7a9747ee 100644 --- a/docs/reference/octl_storage_api_PutObjectRetention.md +++ b/docs/reference/octl_storage_api_PutObjectRetention.md @@ -9,12 +9,12 @@ octl storage api PutObjectRetention [flags] ### Options ``` - --Bucket string The bucket name that contains the object you want to apply this Object Retention configuration to. + --Bucket string [REQUIRED] The bucket name that contains the object you want to apply this Object Retention configuration to. --BypassGovernanceRetention Indicates whether this action should bypass Governance-mode restrictions. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. --ContentMD5 string The MD5 hash for the request body. --ExpectedBucketOwner string The account ID of the expected bucket owner. - --Key string The key name for the object that you want to apply this Object Retention configuration to. + --Key string [REQUIRED] The key name for the object that you want to apply this Object Retention configuration to. --RequestPayer string Confirms that the requester knows that they will be charged for the request. --Retention.Mode string Indicates the Retention mode for the specified object. --Retention.RetainUntilDate osctime The date on which this Object Lock Retention will expire. diff --git a/docs/reference/octl_storage_api_PutObjectTagging.md b/docs/reference/octl_storage_api_PutObjectTagging.md index fa93d7d2..adbb48db 100644 --- a/docs/reference/octl_storage_api_PutObjectTagging.md +++ b/docs/reference/octl_storage_api_PutObjectTagging.md @@ -9,14 +9,14 @@ octl storage api PutObjectTagging [flags] ### Options ``` - --Bucket string The bucket name containing the object. + --Bucket string [REQUIRED] The bucket name containing the object. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. --ContentMD5 string The MD5 hash for the request body. --ExpectedBucketOwner string The account ID of the expected bucket owner. - --Key string Name of the object key. + --Key string [REQUIRED] Name of the object key. --RequestPayer string Confirms that the requester knows that they will be charged for the request. - --Tagging.TagSet.0.Key string Name of the object key. - --Tagging.TagSet.0.Value string of the tag. + --Tagging.TagSet.0.Key string [REQUIRED] Name of the object key. + --Tagging.TagSet.0.Value string [REQUIRED] of the tag. --VersionId string The versionId of the object that the tag-set will be added to. -h, --help help for PutObjectTagging ``` diff --git a/docs/reference/octl_storage_api_UploadPart.md b/docs/reference/octl_storage_api_UploadPart.md index 547df4d8..0006de08 100644 --- a/docs/reference/octl_storage_api_UploadPart.md +++ b/docs/reference/octl_storage_api_UploadPart.md @@ -10,7 +10,7 @@ octl storage api UploadPart [flags] ``` --Body streamedFile Object data. - --Bucket string The name of the bucket to which the multipart upload was initiated. + --Bucket string [REQUIRED] The name of the bucket to which the multipart upload was initiated. --ChecksumAlgorithm string Indicates the algorithm used to create the checksum for the object when you use the SDK. --ChecksumCRC32 string This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. --ChecksumCRC32C string This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. @@ -19,13 +19,13 @@ octl storage api UploadPart [flags] --ContentLength int Size of the body in bytes. --ContentMD5 string The base64-encoded 128-bit MD5 digest of the part data. --ExpectedBucketOwner string The account ID of the expected bucket owner. - --Key string Object key for which the multipart upload was initiated. - --PartNumber int32 Part number of part being uploaded. + --Key string [REQUIRED] Object key for which the multipart upload was initiated. + --PartNumber int32 [REQUIRED] Part number of part being uploaded. --RequestPayer string Confirms that the requester knows that they will be charged for the request. --SSECustomerAlgorithm string Specifies the algorithm to use when encrypting the object (for example, AES256). --SSECustomerKey string Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. --SSECustomerKeyMD5 string Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. - --UploadId string Upload ID identifying the multipart upload whose part is being uploaded. + --UploadId string [REQUIRED] Upload ID identifying the multipart upload whose part is being uploaded. -h, --help help for UploadPart ``` diff --git a/docs/reference/octl_storage_api_UploadPartCopy.md b/docs/reference/octl_storage_api_UploadPartCopy.md index 5630fd38..7a5e0c74 100644 --- a/docs/reference/octl_storage_api_UploadPartCopy.md +++ b/docs/reference/octl_storage_api_UploadPartCopy.md @@ -9,8 +9,8 @@ octl storage api UploadPartCopy [flags] ### Options ``` - --Bucket string The bucket name. - --CopySource string Specifies the source object for the copy operation. + --Bucket string [REQUIRED] The bucket name. + --CopySource string [REQUIRED] Specifies the source object for the copy operation. --CopySourceIfMatch string Copies the object if its entity tag (ETag) matches the specified tag. --CopySourceIfModifiedSince osctime Copies the object if it has been modified since the specified time. --CopySourceIfNoneMatch string Copies the object if its entity tag (ETag) is different than the specified ETag. @@ -21,13 +21,13 @@ octl storage api UploadPartCopy [flags] --CopySourceSSECustomerKeyMD5 string Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. --ExpectedBucketOwner string The account ID of the expected destination bucket owner. --ExpectedSourceBucketOwner string The account ID of the expected source bucket owner. - --Key string Object key for which the multipart upload was initiated. - --PartNumber int32 Part number of part being copied. + --Key string [REQUIRED] Object key for which the multipart upload was initiated. + --PartNumber int32 [REQUIRED] Part number of part being copied. --RequestPayer string Confirms that the requester knows that they will be charged for the request. --SSECustomerAlgorithm string Specifies the algorithm to use when encrypting the object (for example, AES256). --SSECustomerKey string Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. --SSECustomerKeyMD5 string Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. - --UploadId string Upload ID identifying the multipart upload whose part is being copied. + --UploadId string [REQUIRED] Upload ID identifying the multipart upload whose part is being copied. -h, --help help for UploadPartCopy ``` diff --git a/docs/reference/octl_storage_bucket_create.md b/docs/reference/octl_storage_bucket_create.md index 5233cc64..0b63457d 100644 --- a/docs/reference/octl_storage_bucket_create.md +++ b/docs/reference/octl_storage_bucket_create.md @@ -16,7 +16,7 @@ octl storage bucket create [flags] ``` --acl string The canned ACL to apply to the bucket. - --bucket string The name of the bucket to create. + --bucket string [REQUIRED] The name of the bucket to create. --grant-full-control string Allows grantee the read, write, read ACP, and write ACP permissions on the bucket. --grant-read string Allows grantee to list the objects in the bucket. --grant-read-acp string Allows grantee to read the bucket ACL. diff --git a/docs/reference/octl_storage_multipartupload_create.md b/docs/reference/octl_storage_multipartupload_create.md index 58001f4c..1c37d3d1 100644 --- a/docs/reference/octl_storage_multipartupload_create.md +++ b/docs/reference/octl_storage_multipartupload_create.md @@ -16,7 +16,7 @@ octl storage multipartupload create [flags] ``` --acl string The canned ACL to apply to the object. - --bucket string The name of the bucket where the multipart upload is initiated and where the object is uploaded. + --bucket string [REQUIRED] The name of the bucket where the multipart upload is initiated and where the object is uploaded. --bucket-key-enabled Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). --cache-control string Specifies caching behavior along the request/reply chain. --content-disposition string Specifies presentational information for the object. @@ -30,7 +30,7 @@ octl storage multipartupload create [flags] --grant-read-acp string Specify access permissions explicitly to allows grantee to read the object ACL. --grant-write-acp string Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object. -h, --help help for create - --key string Object key for which the multipart upload is to be initiated. + --key string [REQUIRED] Object key for which the multipart upload is to be initiated. --metadatum stringToString A map of metadata to store with the object in S3. (default []) --object-lock-legal-hold-status string Specifies whether you want to apply a legal hold to the uploaded object. --object-lock-mode string Specifies the Object Lock mode that you want to apply to the uploaded object. diff --git a/docs/reference/octl_storage_multipartupload_list.md b/docs/reference/octl_storage_multipartupload_list.md index 170eb6bc..fea0f998 100644 --- a/docs/reference/octl_storage_multipartupload_list.md +++ b/docs/reference/octl_storage_multipartupload_list.md @@ -15,7 +15,7 @@ octl storage multipartupload list [flags] ### Options ``` - --bucket string The name of the bucket to which the multipart upload was initiated. + --bucket string [REQUIRED] The name of the bucket to which the multipart upload was initiated. --delimiter string Character you use to group keys. --encoding-type string Encoding type used by Amazon S3 to encode the [object keys] in the response. --expected-bucket-owner string The account ID of the expected bucket owner. diff --git a/docs/reference/octl_storage_object_acl_configure.md b/docs/reference/octl_storage_object_acl_configure.md index 27401a41..2aa70a27 100644 --- a/docs/reference/octl_storage_object_acl_configure.md +++ b/docs/reference/octl_storage_object_acl_configure.md @@ -15,7 +15,7 @@ octl storage object acl configure key [flags] ### Options ``` - --bucket string The bucket name that contains the object to which you want to attach the ACL. + --bucket string [REQUIRED] The bucket name that contains the object to which you want to attach the ACL. --from-file string The file storing the ACL config (JSON format, i.e. {"Grants":[...]}) --from-string string The ACL config (JSON format, i.e. {"Grants":[...]}) -h, --help help for configure diff --git a/docs/reference/octl_storage_object_acl_describe.md b/docs/reference/octl_storage_object_acl_describe.md index edf0c5f3..a4c52c10 100644 --- a/docs/reference/octl_storage_object_acl_describe.md +++ b/docs/reference/octl_storage_object_acl_describe.md @@ -15,7 +15,7 @@ octl storage object acl describe key [flags] ### Options ``` - --bucket string The bucket name that contains the object for which to get the ACL information. + --bucket string [REQUIRED] The bucket name that contains the object for which to get the ACL information. -h, --help help for describe ``` diff --git a/docs/reference/octl_storage_object_copy.md b/docs/reference/octl_storage_object_copy.md index 30c4b6f5..de38132a 100644 --- a/docs/reference/octl_storage_object_copy.md +++ b/docs/reference/octl_storage_object_copy.md @@ -15,7 +15,7 @@ octl storage object copy bucket_src/key_src key_dst [flags] ### Options ``` - --bucket string The name of the destination bucket. + --bucket string [REQUIRED] The name of the destination bucket. --cache-control string Specifies the caching behavior along the request/reply chain. --content-disposition string Specifies presentational information for the object. --content-encoding string Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. diff --git a/docs/reference/octl_storage_object_delete.md b/docs/reference/octl_storage_object_delete.md index 78cd5fe8..31f2a02a 100644 --- a/docs/reference/octl_storage_object_delete.md +++ b/docs/reference/octl_storage_object_delete.md @@ -15,7 +15,7 @@ octl storage object delete key [key]... [flags] ### Options ``` - --bucket string The bucket name of the bucket containing the object. + --bucket string [REQUIRED] The bucket name of the bucket containing the object. --bypass-governance-retention Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. --expected-bucket-owner string The account ID of the expected bucket owner. -h, --help help for delete diff --git a/docs/reference/octl_storage_object_describe.md b/docs/reference/octl_storage_object_describe.md index a471da45..a2cbe284 100644 --- a/docs/reference/octl_storage_object_describe.md +++ b/docs/reference/octl_storage_object_describe.md @@ -15,7 +15,7 @@ octl storage object describe key [flags] ### Options ``` - --bucket string The name of the bucket that contains the object. + --bucket string [REQUIRED] The name of the bucket that contains the object. -h, --help help for describe ``` diff --git a/docs/reference/octl_storage_object_download.md b/docs/reference/octl_storage_object_download.md index a0593d9c..6d76d1af 100644 --- a/docs/reference/octl_storage_object_download.md +++ b/docs/reference/octl_storage_object_download.md @@ -15,7 +15,7 @@ octl storage object download key [flags] ### Options ``` - --bucket string The bucket name containing the object. + --bucket string [REQUIRED] The bucket name containing the object. -h, --help help for download --part int32 Part number of the object being read. --range string Range to download, as defined by RFC 9110 (e.g. bytes=0-500) diff --git a/docs/reference/octl_storage_object_list.md b/docs/reference/octl_storage_object_list.md index 43c1ddaa..02ed485a 100644 --- a/docs/reference/octl_storage_object_list.md +++ b/docs/reference/octl_storage_object_list.md @@ -15,7 +15,7 @@ octl storage object list [flags] ### Options ``` - --bucket string Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com . + --bucket string [REQUIRED] Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com . --delimiter string A delimiter is a character that you use to group keys. --encoding-type string Encoding type used by Amazon S3 to encode the [object keys] in the response. --expected-bucket-owner string The account ID of the expected bucket owner. diff --git a/docs/reference/octl_storage_object_put.md b/docs/reference/octl_storage_object_put.md index 6bb2a0de..011a5efe 100644 --- a/docs/reference/octl_storage_object_put.md +++ b/docs/reference/octl_storage_object_put.md @@ -17,7 +17,7 @@ octl storage object put key [key]... [flags] ``` --acl string The canned ACL to apply to the object. --body streamedFile Object data. - --bucket string The bucket name to which the PUT action was initiated. + --bucket string [REQUIRED] The bucket name to which the PUT action was initiated. --bucket-key-enabled Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). --cache-control string Can be used to specify caching behavior along the request/reply chain. --content-disposition string Specifies presentational information for the object. diff --git a/docs/reference/octl_storage_object_retention_configure.md b/docs/reference/octl_storage_object_retention_configure.md index aed9704a..782de921 100644 --- a/docs/reference/octl_storage_object_retention_configure.md +++ b/docs/reference/octl_storage_object_retention_configure.md @@ -15,9 +15,9 @@ octl storage object retention configure key [flags] ### Options ``` - --bucket string The bucket name that contains the object you want to apply this Object Retention configuration to. + --bucket string [REQUIRED] The bucket name that contains the object you want to apply this Object Retention configuration to. -h, --help help for configure - --retain-until osctime The date on which this Object Lock Retention will expire. + --retain-until osctime [REQUIRED] The date on which this Object Lock Retention will expire. ``` ### Options inherited from parent commands diff --git a/docs/reference/octl_storage_object_retention_desc.md b/docs/reference/octl_storage_object_retention_desc.md index d888e753..868f245f 100644 --- a/docs/reference/octl_storage_object_retention_desc.md +++ b/docs/reference/octl_storage_object_retention_desc.md @@ -15,7 +15,7 @@ octl storage object retention desc key [flags] ### Options ``` - --bucket string The bucket name containing the object whose retention settings you want to retrieve. + --bucket string [REQUIRED] The bucket name containing the object whose retention settings you want to retrieve. -h, --help help for desc ``` diff --git a/docs/reference/octl_storage_object_tagging_configure.md b/docs/reference/octl_storage_object_tagging_configure.md index af075960..6608e49f 100644 --- a/docs/reference/octl_storage_object_tagging_configure.md +++ b/docs/reference/octl_storage_object_tagging_configure.md @@ -15,7 +15,7 @@ octl storage object tagging configure key [flags] ### Options ``` - --bucket string The bucket name containing the object. + --bucket string [REQUIRED] The bucket name containing the object. --from-file string The file storing the tagging config (JSON format, i.e. {"TagSet":[{"Key":"...", "Value":"..."}]}) --from-string string The tagging config (JSON format, i.e. {"TagSet":[{"Key":"...", "Value":"..."}]}) -h, --help help for configure diff --git a/docs/reference/octl_storage_object_tagging_delete.md b/docs/reference/octl_storage_object_tagging_delete.md index a59cbb0c..877b9ad8 100644 --- a/docs/reference/octl_storage_object_tagging_delete.md +++ b/docs/reference/octl_storage_object_tagging_delete.md @@ -15,7 +15,7 @@ octl storage object tagging delete key [flags] ### Options ``` - --bucket string The bucket name containing the objects from which to remove the tags. + --bucket string [REQUIRED] The bucket name containing the objects from which to remove the tags. -h, --help help for delete ``` diff --git a/docs/reference/octl_storage_object_tagging_describe.md b/docs/reference/octl_storage_object_tagging_describe.md index 1315629e..9545ab1b 100644 --- a/docs/reference/octl_storage_object_tagging_describe.md +++ b/docs/reference/octl_storage_object_tagging_describe.md @@ -15,7 +15,7 @@ octl storage object tagging describe key [flags] ### Options ``` - --bucket string The bucket name containing the object for which to get the tagging information. + --bucket string [REQUIRED] The bucket name containing the object for which to get the tagging information. -h, --help help for describe ``` diff --git a/docs/reference/octl_storage_object_versions.md b/docs/reference/octl_storage_object_versions.md index 9834dc87..720d694d 100644 --- a/docs/reference/octl_storage_object_versions.md +++ b/docs/reference/octl_storage_object_versions.md @@ -15,7 +15,7 @@ octl storage object versions [flags] ### Options ``` - --bucket string The bucket name that contains the objects. + --bucket string [REQUIRED] The bucket name that contains the objects. -h, --help help for versions ``` diff --git a/docs/reference/octl_storage_part_list.md b/docs/reference/octl_storage_part_list.md index 9d57f222..06b00a4e 100644 --- a/docs/reference/octl_storage_part_list.md +++ b/docs/reference/octl_storage_part_list.md @@ -15,13 +15,13 @@ octl storage part list [flags] ### Options ``` - --bucket string The name of the bucket to which the parts are being uploaded. + --bucket string [REQUIRED] The name of the bucket to which the parts are being uploaded. --expected-bucket-owner string The account ID of the expected bucket owner. -h, --help help for list - --key string Object key for which the multipart upload was initiated. + --key string [REQUIRED] Object key for which the multipart upload was initiated. --max-part int32 Sets the maximum number of parts to return. --number-marker string Specifies the part after which listing should begin. - --upload-id string Upload ID identifying the multipart upload whose parts are being listed. + --upload-id string [REQUIRED] Upload ID identifying the multipart upload whose parts are being listed. ``` ### Options inherited from parent commands diff --git a/pkg/builder/build.go b/pkg/builder/build.go index 3386c832..6b290c8e 100644 --- a/pkg/builder/build.go +++ b/pkg/builder/build.go @@ -112,6 +112,9 @@ func (b *Builder[T]) Build(rootCmd, apiCmd *cobra.Command) { if f.Usage != "" { nflag.Usage = f.Usage } + if f.Required { + nflag.Usage = flagbuilder.RequiredHelp(nflag.Usage) + } cmd.Flags().AddFlag(&nflag) completion, found := callCmd.GetFlagCompletionFunc(f.AliasTo) diff --git a/pkg/builder/flags/flags.go b/pkg/builder/flags/flags.go index 89d18503..e3e7c7ef 100644 --- a/pkg/builder/flags/flags.go +++ b/pkg/builder/flags/flags.go @@ -97,13 +97,17 @@ func (b *Builder) Build(fs *FlagSet, arg reflect.Type, prefix string, allowRequi if spec.Required { required = spec.Required } + help := spec.Help + if required { + help = RequiredHelp(help) + } switch t.Kind() { case reflect.Bool, reflect.String, reflect.Int, reflect.Int32, reflect.Int64: f := Flag{ Name: b.normalize(flagName), FieldPath: flagName, Kind: t.Kind(), - Help: spec.Help, + Help: help, Required: required, Slice: slice, } @@ -121,7 +125,7 @@ func (b *Builder) Build(fs *FlagSet, arg reflect.Type, prefix string, allowRequi Name: b.normalize(flagName), FieldPath: flagName, Kind: reflect.Map, - Help: spec.Help, + Help: help, Required: required, } fs.Add(f) @@ -134,7 +138,7 @@ func (b *Builder) Build(fs *FlagSet, arg reflect.Type, prefix string, allowRequi Name: b.normalize(flagName), FieldPath: flagName, Kind: reflect.String, - Help: spec.Help, + Help: help, Required: required, Slice: slice, FlagValue: flags.NewReaderValue(), @@ -148,7 +152,7 @@ func (b *Builder) Build(fs *FlagSet, arg reflect.Type, prefix string, allowRequi Name: b.normalize(flagName), FieldPath: flagName, Kind: reflect.String, - Help: spec.Help, + Help: help, Required: required, Slice: slice, FlagValue: flags.NewTimeValue(), @@ -159,7 +163,7 @@ func (b *Builder) Build(fs *FlagSet, arg reflect.Type, prefix string, allowRequi Name: b.normalize(flagName), FieldPath: flagName, Kind: reflect.String, - Help: spec.Help, + Help: help, Required: required, Slice: slice, } diff --git a/pkg/builder/flags/required.go b/pkg/builder/flags/required.go new file mode 100644 index 00000000..daa494b5 --- /dev/null +++ b/pkg/builder/flags/required.go @@ -0,0 +1,14 @@ +package flags + +import ( + "strings" +) + +const required = "[REQUIRED]" + +func RequiredHelp(help string) string { + if strings.HasPrefix(help, required) { + return help + } + return required + " " + help +}