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

gcloud/alpha/alloydb/clusters/create

@@ -0,0 +1,57 @@
+NAME
+    gcloud alpha alloydb clusters create - creates a new AlloyDB cluster within
+        a given project
+
+SYNOPSIS
+    gcloud alpha alloydb clusters create CLUSTER --password=PASSWORD
+        --region=REGION [--async] [--network=NETWORK] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Creates a new AlloyDB cluster within a given project.
+
+EXAMPLES
+    To create a new cluster, run:
+
+        $ gcloud alpha alloydb clusters create my-cluster \
+            --region=us-central1 --password=postgres
+
+POSITIONAL ARGUMENTS
+     CLUSTER
+        AlloyDB cluster ID
+
+REQUIRED FLAGS
+     --password=PASSWORD
+        Initial postgres user password to set up during cluster creation.
+
+     --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.
+
+     --network=NETWORK
+        Network in the current project that the instance will be part of. To
+        specify using a network with a shared VPC, use the full URL of the
+        network. For an example host project, 'testproject', and shared
+        network, 'testsharednetwork', this would be of the
+        form:--network=projects/testproject/global/networks/testsharednetwork
+
+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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta alloydb clusters create
+

gcloud/alpha/alloydb/clusters/delete

@@ -0,0 +1,56 @@
+NAME
+    gcloud alpha alloydb clusters delete - deletes an AlloyDB cluster in a
+        given region
+
+SYNOPSIS
+    gcloud alpha alloydb clusters delete CLUSTER --region=REGION [--async]
+        [--force] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Deletes an AlloyDB cluster in a given region.
+
+EXAMPLES
+    To delete a cluster, run:
+
+        $ gcloud alpha alloydb clusters delete my-cluster \
+            --region=us-central1
+
+POSITIONAL ARGUMENTS
+     CLUSTER
+        AlloyDB cluster ID
+
+REQUIRED FLAGS
+     --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.
+
+     --force
+        Default value is false.
+
+        If flag is specified, deletes instances (if any) within this cluster,
+        before deleting the cluster.
+
+        If flag is not specified, cluster delete will fail if there are
+        instances present in the cluster.
+
+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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta alloydb clusters delete
+

gcloud/alpha/alloydb/clusters/describe

@@ -0,0 +1,42 @@
+NAME
+    gcloud alpha alloydb clusters describe - describes an AlloyDB cluster in a
+        given project and region
+
+SYNOPSIS
+    gcloud alpha alloydb clusters describe CLUSTER --region=REGION
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Describes an AlloyDB cluster in a given project and region.
+
+EXAMPLES
+    To describe a cluster, run:
+
+        $ gcloud alpha alloydb clusters describe my-cluster \
+            --region=us-central1
+
+POSITIONAL ARGUMENTS
+     CLUSTER
+        AlloyDB cluster ID
+
+REQUIRED FLAGS
+     --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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta alloydb clusters describe
+

gcloud/alpha/alloydb/clusters/help

@@ -0,0 +1,45 @@
+NAME
+    gcloud alpha alloydb clusters - provide commands for managing AlloyDB
+        clusters
+
+SYNOPSIS
+    gcloud alpha alloydb clusters COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Provide commands for managing AlloyDB clusters including creating,
+    configuring, restarting, and deleting clusters.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     create
+        (ALPHA) Creates a new AlloyDB cluster within a given project.
+
+     delete
+        (ALPHA) Deletes an AlloyDB cluster in a given region.
+
+     describe
+        (ALPHA) Describes an AlloyDB cluster in a given project and region.
+
+     list
+        (ALPHA) Lists AlloyDB clusters in a given project and region.
+
+     restore
+        (ALPHA) Restores an AlloyDB cluster from a given backup.
+
+     update
+        (ALPHA) Updates an AlloyDB cluster within a given project and region.
+
+NOTES
+    This command is currently in alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta alloydb clusters
+

gcloud/alpha/alloydb/clusters/list

@@ -0,0 +1,72 @@
+NAME
+    gcloud alpha alloydb clusters list - lists AlloyDB clusters in a given
+        project and region
+
+SYNOPSIS
+    gcloud alpha alloydb clusters list [--region=REGION; default="-"]
+        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
+        [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Lists AlloyDB clusters in a given project in the alphabetical order
+    of the cluster name.
+
+EXAMPLES
+    To list clusters, run:
+
+        $ gcloud alpha alloydb clusters list --region=us-central1
+
+FLAGS
+     --region=REGION; default="-"
+        Regional location (e.g. asia-east1, us-east1). See the full list of
+        regions at https://cloud.google.com/sql/docs/instance-locations.
+        Default: list clusters in all regions.
+
+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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta alloydb clusters list
+

gcloud/alpha/alloydb/clusters/restore

@@ -0,0 +1,57 @@
+NAME
+    gcloud alpha alloydb clusters restore - restores an AlloyDB cluster from a
+        given backup
+
+SYNOPSIS
+    gcloud alpha alloydb clusters restore CLUSTER --backup=BACKUP
+        --region=REGION [--async] [--network=NETWORK] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Restores an AlloyDB cluster from a given backup.
+
+EXAMPLES
+    To restore a cluster from a backup, run:
+
+        $ gcloud alpha alloydb clusters restore my-cluster \
+            --region=us-central1 --backup=my-backup
+
+POSITIONAL ARGUMENTS
+     CLUSTER
+        AlloyDB cluster ID
+
+REQUIRED FLAGS
+     --backup=BACKUP
+        AlloyDB backup 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.
+
+     --network=NETWORK
+        Network in the current project that the instance will be part of. To
+        specify using a network with a shared VPC, use the full URL of the
+        network. For an example host project, 'testproject', and shared
+        network, 'testsharednetwork', this would be of the
+        form:--network=projects/testproject/global/networks/testsharednetwork
+
+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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta alloydb clusters restore
+

gcloud/alpha/alloydb/clusters/update

@@ -0,0 +1,106 @@
+NAME
+    gcloud alpha alloydb clusters update - updates an AlloyDB cluster within a
+        given project and region
+
+SYNOPSIS
+    gcloud alpha alloydb clusters update CLUSTER --region=REGION [--async]
+        [--clear-automated-backup | --disable-automated-backup
+          | [--automated-backup-days-of-week=[DAYS_OF_WEEK,...]
+          --automated-backup-start-times=[START_TIMES,...]
+          : --automated-backup-window=TIMEOUT_PERIOD
+          --automated-backup-retention-count=RETENTION_COUNT
+          | --automated-backup-retention-period=RETENTION_PERIOD]]
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Updates an AlloyDB cluster within a given project and region.
+
+EXAMPLES
+    To update a cluster, run:
+
+        $ gcloud alpha alloydb clusters update my-cluster \
+            --region=us-central1 --automated-backup-start-times=12:00 \
+            --automated-backup-days-of-week=MONDAY \
+            --automated-backup-retention-count=10
+
+POSITIONAL ARGUMENTS
+     CLUSTER
+        AlloyDB cluster ID
+
+REQUIRED FLAGS
+     --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.
+
+     Automated backup policy.
+
+     At most one of these can be specified:
+
+       --clear-automated-backup
+          Clears the automated backup policy on the cluster. The default
+          automated backup policy will be used.
+
+       --disable-automated-backup
+          Disables automated backups on the cluster.
+
+       Enable automated backup policy.
+
+         --automated-backup-days-of-week=[DAYS_OF_WEEK,...]
+            Comma-separated list of days of the week to perform a backup. At
+            least one day of the week must be provided. (e.g.,
+            --automated-backup-days-of-week=MONDAY,WEDNESDAY,SUNDAY).
+            DAYS_OF_WEEK must be one of: MONDAY, TUESDAY, WEDNESDAY, THURSDAY,
+            FRIDAY, SATURDAY, SUNDAY.
+
+            This flag must be specified if any of the other arguments in this
+            group are specified.
+
+         --automated-backup-start-times=[START_TIMES,...]
+            Comma-separated list of times during the day to start a backup. At
+            least one start time must be provided. The start times are assumed
+            to be in UTC and required to be an exact hour in the format HH:00.
+            (e.g., --automated-backup-start-times=01:00,13:00)
+
+            This flag must be specified if any of the other arguments in this
+            group are specified.
+
+         --automated-backup-window=TIMEOUT_PERIOD
+            The length of the time window beginning at start time during which
+            a backup can be taken. If a backup does not succeed within this
+            time window, it will be canceled and considered failed. The backup
+            window must be at least 5 minutes long. There is no upper bound on
+            the window. If not set, it will default to 1 hour.
+
+         Retention policy. If no retention policy is provided, all automated
+         backups will be retained.
+
+         At most one of these can be specified:
+
+           --automated-backup-retention-count=RETENTION_COUNT
+              Number of most recent successful backups retained.
+
+           --automated-backup-retention-period=RETENTION_PERIOD
+              Retention period of the backup relative to creation time. See $
+              gcloud topic datetimes for information on duration formats.
+
+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 alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. This variant is also available:
+
+        $ gcloud beta alloydb clusters update
+