gcloud: Wed May 18 08:41:01 UTC 2022

gcloud/beta/alloydb/instances/create

@@ -0,0 +1,100 @@
+NAME
+    gcloud beta alloydb instances create - creates a new AlloyDB instance
+        within a given cluster
+
+SYNOPSIS
+    gcloud beta alloydb instances create INSTANCE --cluster=CLUSTER
+        --cpu-count=CPU_COUNT --instance-type=INSTANCE_TYPE --region=REGION
+        [--async] [--availability-type=AVAILABILITY_TYPE]
+        [--database-flags=FLAG=VALUE,[FLAG=VALUE,...]]
+        [--read-pool-node-count=READ_POOL_NODE_COUNT] [--zone=ZONE]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Creates a new AlloyDB instance within a given cluster.
+
+EXAMPLES
+    To create a new primary instance, run:
+
+        $ gcloud beta alloydb instances create my-instance \
+            --cluster=my-cluster --region=us-central1 \
+            --instance-type=PRIMARY --cpu-count=4
+
+    To create a new read pool instance, run:
+
+        $ gcloud beta alloydb instances create my-instance \
+            --cluster=my-cluster --region=us-central1 \
+            --instance-type=READ_POOL --read-pool-node-count=1 --cpu-count=4
+
+POSITIONAL ARGUMENTS
+     INSTANCE
+        AlloyDB instance ID
+
+REQUIRED FLAGS
+     --cluster=CLUSTER
+        AlloyDB cluster ID
+
+     --cpu-count=CPU_COUNT
+        Whole number value indicating how many vCPUs the machine should
+        contain. Each vCPU count corresponds to a N2 high-mem machine:
+        (https://cloud.google.com/compute/docs/general-purpose-machines#n2_machines).
+        CPU_COUNT must be one of: 4, 8, 16, 32, 64.
+
+     --instance-type=INSTANCE_TYPE
+        Specifies instance type. INSTANCE_TYPE must be one of:
+
+         PRIMARY
+            PRIMARY instances support read and write operations.
+         READ_POOL
+            READ_POOL instances support read operations only. Each read pool
+            instance consists of one or more homogeneous nodes. * Read pool of
+            size 1 can only have zonal availability. * Read pools with node
+            count of 2 or more can have regional availability (nodes are
+            present in 2 or more zones in a region).
+
+     --region=REGION
+        Regional location (e.g. asia-east1, us-east1). See the full list of
+        regions at https://cloud.google.com/sql/docs/instance-locations.
+
+OPTIONAL FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+     --availability-type=AVAILABILITY_TYPE
+        Specifies level of availability. AVAILABILITY_TYPE must be (currently
+        only one value is supported):
+
+         REGIONAL
+            Provides high availability and is recommended for production
+            instances; instance automatically fails over to another zone within
+            your selected region.
+
+     --database-flags=FLAG=VALUE,[FLAG=VALUE,...]
+        Comma-separated list of database flags to set on the instance. Use an
+        equals sign to separate flag name and value. Flags without values, like
+        skip_grant_tables, can be written out without a value after, e.g.,
+        skip_grant_tables=. Use on/off for booleans. View the Instance Resource
+        API for allowed flags. (e.g., --database-flags
+        max_allowed_packet=55555,skip_grant_tables=,log_output=1)
+
+     --read-pool-node-count=READ_POOL_NODE_COUNT
+        Read capacity, i.e. number of nodes in a read pool instance.
+
+     --zone=ZONE
+        Primary Compute Engine zone (e.g. us-central1, us-central1, etc.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --access-token-file, --account,
+    --billing-project, --configuration, --flags-file, --flatten, --format,
+    --help, --impersonate-service-account, --log-http, --project, --quiet,
+    --trace-token, --user-output-enabled, --verbosity.
+
+    Run $ gcloud help for details.
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha alloydb instances create
+

gcloud/beta/alloydb/instances/delete

@@ -0,0 +1,48 @@
+NAME
+    gcloud beta alloydb instances delete - deletes an AlloyDB instance within a
+        given cluster
+
+SYNOPSIS
+    gcloud beta alloydb instances delete INSTANCE --cluster=CLUSTER
+        --region=REGION [--async] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Deletes an AlloyDB instance within a given cluster.
+
+EXAMPLES
+    To delete an instance, run:
+
+        $ gcloud beta alloydb instances delete my-instance \
+            --cluster=my-cluster --region=us-central1
+
+POSITIONAL ARGUMENTS
+     INSTANCE
+        AlloyDB instance ID
+
+REQUIRED FLAGS
+     --cluster=CLUSTER
+        AlloyDB cluster ID
+
+     --region=REGION
+        Regional location (e.g. asia-east1, us-east1). See the full list of
+        regions at https://cloud.google.com/sql/docs/instance-locations.
+
+OPTIONAL FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --access-token-file, --account,
+    --billing-project, --configuration, --flags-file, --flatten, --format,
+    --help, --impersonate-service-account, --log-http, --project, --quiet,
+    --trace-token, --user-output-enabled, --verbosity.
+
+    Run $ gcloud help for details.
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha alloydb instances delete
+

gcloud/beta/alloydb/instances/describe

@@ -0,0 +1,43 @@
+NAME
+    gcloud beta alloydb instances describe - describes an AlloyDB instance
+        within a given cluster
+
+SYNOPSIS
+    gcloud beta alloydb instances describe INSTANCE --cluster=CLUSTER
+        --region=REGION [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Describes an AlloyDB instance within a given cluster.
+
+EXAMPLES
+    To describe an instance, run:
+
+        $ gcloud beta alloydb instances describe my-instance \
+            --cluster=my-cluster --region=us-central1
+
+POSITIONAL ARGUMENTS
+     INSTANCE
+        AlloyDB instance ID
+
+REQUIRED FLAGS
+     --cluster=CLUSTER
+        AlloyDB cluster ID
+
+     --region=REGION
+        Regional location (e.g. asia-east1, us-east1). See the full list of
+        regions at https://cloud.google.com/sql/docs/instance-locations.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --access-token-file, --account,
+    --billing-project, --configuration, --flags-file, --flatten, --format,
+    --help, --impersonate-service-account, --log-http, --project, --quiet,
+    --trace-token, --user-output-enabled, --verbosity.
+
+    Run $ gcloud help for details.
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha alloydb instances describe
+

gcloud/beta/alloydb/instances/failover

@@ -0,0 +1,48 @@
+NAME
+    gcloud beta alloydb instances failover - failover an AlloyDB instance
+        within a given cluster
+
+SYNOPSIS
+    gcloud beta alloydb instances failover INSTANCE --cluster=CLUSTER
+        --region=REGION [--async] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Failover an AlloyDB instance within a given cluster.
+
+EXAMPLES
+    To failover an instance, run:
+
+        $ gcloud beta alloydb instances failover my-instance \
+            --cluster=my-cluster --region=us-central1
+
+POSITIONAL ARGUMENTS
+     INSTANCE
+        AlloyDB instance ID
+
+REQUIRED FLAGS
+     --cluster=CLUSTER
+        AlloyDB cluster ID
+
+     --region=REGION
+        Regional location (e.g. asia-east1, us-east1). See the full list of
+        regions at https://cloud.google.com/sql/docs/instance-locations.
+
+OPTIONAL FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --access-token-file, --account,
+    --billing-project, --configuration, --flags-file, --flatten, --format,
+    --help, --impersonate-service-account, --log-http, --project, --quiet,
+    --trace-token, --user-output-enabled, --verbosity.
+
+    Run $ gcloud help for details.
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha alloydb instances failover
+

gcloud/beta/alloydb/instances/help

@@ -0,0 +1,46 @@
+NAME
+    gcloud beta alloydb instances - provide commands for managing AlloyDB
+        instances
+
+SYNOPSIS
+    gcloud beta alloydb instances COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Provide commands for managing AlloyDB clusters including creating,
+    configuring, restarting, and deleting instances.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     create
+        (BETA) Creates a new AlloyDB instance within a given cluster.
+
+     delete
+        (BETA) Deletes an AlloyDB instance within a given cluster.
+
+     describe
+        (BETA) Describes an AlloyDB instance within a given cluster.
+
+     failover
+        (BETA) Failover an AlloyDB instance within a given cluster.
+
+     list
+        (BETA) Lists AlloyDB instances in a given cluster.
+
+     restart
+        (BETA) Restarts an AlloyDB instance within a given cluster.
+
+     update
+        (BETA) Updates an AlloyDB instance within a given cluster.
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha alloydb instances
+

gcloud/beta/alloydb/instances/list

@@ -0,0 +1,82 @@
+NAME
+    gcloud beta alloydb instances list - lists AlloyDB instances in a given
+        cluster
+
+SYNOPSIS
+    gcloud beta alloydb instances list [--cluster=CLUSTER --region=REGION]
+        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
+        [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Lists AlloyDB instances in a given cluster.
+
+EXAMPLES
+    To list instances, run:
+
+        $ gcloud beta alloydb instances list --cluster=my-cluster \
+            --region=us-central1
+
+FLAGS
+     Cluster
+
+       --cluster=CLUSTER
+          AlloyDB cluster ID
+
+          This flag must be specified if any of the other arguments in this
+          group are specified.
+
+       --region=REGION
+          Regional location (e.g. asia-east1, us-east1) of CLUSTER. See the
+          full list of regions at
+          https://cloud.google.com/sql/docs/instance-locations. Default: list
+          clusters in all regions.
+
+          This flag must be specified if any of the other arguments in this
+          group are specified.
+
+LIST COMMAND FLAGS
+     --filter=EXPRESSION
+        Apply a Boolean filter EXPRESSION to each resource item to be listed.
+        If the expression evaluates True, then that item is listed. For more
+        details and examples of filter expressions, run $ gcloud topic filters.
+        This flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --limit=LIMIT
+        Maximum number of resources to list. The default is unlimited. This
+        flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --page-size=PAGE_SIZE
+        Some services group resource list output into pages. This flag
+        specifies the maximum number of resources per page. The default is
+        determined by the service if it supports paging, otherwise it is
+        unlimited (no paging). Paging may be applied before or after --filter
+        and --limit depending on the service.
+
+     --sort-by=[FIELD,...]
+        Comma-separated list of resource field key names to sort by. The
+        default order is ascending. Prefix a field with ``~'' for descending
+        order on that field. This flag interacts with other flags that are
+        applied in this order: --flatten, --sort-by, --filter, --limit.
+
+     --uri
+        Print a list of resource URIs instead of the default output, and change
+        the command output to a list of URIs. If this flag is used with
+        --format, the formatting is applied on this URI list. To display URIs
+        alongside other keys instead, use the uri() transform.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --access-token-file, --account,
+    --billing-project, --configuration, --flags-file, --flatten, --format,
+    --help, --impersonate-service-account, --log-http, --project, --quiet,
+    --trace-token, --user-output-enabled, --verbosity.
+
+    Run $ gcloud help for details.
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha alloydb instances list
+

gcloud/beta/alloydb/instances/restart

@@ -0,0 +1,48 @@
+NAME
+    gcloud beta alloydb instances restart - restarts an AlloyDB instance within
+        a given cluster
+
+SYNOPSIS
+    gcloud beta alloydb instances restart INSTANCE --cluster=CLUSTER
+        --region=REGION [--async] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Restarts an AlloyDB instance within a given cluster.
+
+EXAMPLES
+    To describe an instance, run:
+
+        $ gcloud beta alloydb instances restart my-instance \
+            --cluster=my-cluster --region=us-central1
+
+POSITIONAL ARGUMENTS
+     INSTANCE
+        AlloyDB instance ID
+
+REQUIRED FLAGS
+     --cluster=CLUSTER
+        AlloyDB cluster ID
+
+     --region=REGION
+        Regional location (e.g. asia-east1, us-east1). See the full list of
+        regions at https://cloud.google.com/sql/docs/instance-locations.
+
+OPTIONAL FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --access-token-file, --account,
+    --billing-project, --configuration, --flags-file, --flatten, --format,
+    --help, --impersonate-service-account, --log-http, --project, --quiet,
+    --trace-token, --user-output-enabled, --verbosity.
+
+    Run $ gcloud help for details.
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha alloydb instances restart
+

gcloud/beta/alloydb/instances/update

@@ -0,0 +1,81 @@
+NAME
+    gcloud beta alloydb instances update - updates an AlloyDB instance within a
+        given cluster
+
+SYNOPSIS
+    gcloud beta alloydb instances update INSTANCE --cluster=CLUSTER
+        --region=REGION [--async] [--availability-type=AVAILABILITY_TYPE]
+        [--cpu-count=CPU_COUNT] [--database-flags=FLAG=VALUE,[FLAG=VALUE,...]]
+        [--read-pool-node-count=READ_POOL_NODE_COUNT] [--zone=ZONE]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Updates an AlloyDB instance within a given cluster.
+
+EXAMPLES
+    To update the number of nodes in the read pool, run:
+
+        $ gcloud beta alloydb instances update my-read-instance \
+            --cluster=my-cluster --region=us-central1 \
+            --read-pool-node-count=3
+
+POSITIONAL ARGUMENTS
+     INSTANCE
+        AlloyDB instance ID
+
+REQUIRED FLAGS
+     --cluster=CLUSTER
+        AlloyDB cluster ID
+
+     --region=REGION
+        Regional location (e.g. asia-east1, us-east1). See the full list of
+        regions at https://cloud.google.com/sql/docs/instance-locations.
+
+OPTIONAL FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+     --availability-type=AVAILABILITY_TYPE
+        Specifies level of availability. AVAILABILITY_TYPE must be (currently
+        only one value is supported):
+
+         REGIONAL
+            Provides high availability and is recommended for production
+            instances; instance automatically fails over to another zone within
+            your selected region.
+
+     --cpu-count=CPU_COUNT
+        Whole number value indicating how many vCPUs the machine should
+        contain. Each vCPU count corresponds to a N2 high-mem machine:
+        (https://cloud.google.com/compute/docs/general-purpose-machines#n2_machines).
+        CPU_COUNT must be one of: 4, 8, 16, 32, 64.
+
+     --database-flags=FLAG=VALUE,[FLAG=VALUE,...]
+        Comma-separated list of database flags to set on the instance. Use an
+        equals sign to separate flag name and value. Flags without values, like
+        skip_grant_tables, can be written out without a value after, e.g.,
+        skip_grant_tables=. Use on/off for booleans. View the Instance Resource
+        API for allowed flags. (e.g., --database-flags
+        max_allowed_packet=55555,skip_grant_tables=,log_output=1)
+
+     --read-pool-node-count=READ_POOL_NODE_COUNT
+        Read capacity, i.e. number of nodes in a read pool instance.
+
+     --zone=ZONE
+        Primary Compute Engine zone (e.g. us-central1, us-central1, etc.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --access-token-file, --account,
+    --billing-project, --configuration, --flags-file, --flatten, --format,
+    --help, --impersonate-service-account, --log-http, --project, --quiet,
+    --trace-token, --user-output-enabled, --verbosity.
+
+    Run $ gcloud help for details.
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha alloydb instances update
+