gcloud: Thu May 30 09:26:18 UTC 2024

gcloud/beta/managed-kafka/clusters/create

@@ -0,0 +1,114 @@
+NAME
+    gcloud beta managed-kafka clusters create - create an Apache Kafka for
+        BigQuery cluster
+
+SYNOPSIS
+    gcloud beta managed-kafka clusters create (CLUSTER : --location=LOCATION)
+        --cpu=CPU --memory=MEMORY --subnets=[SUBNETS,...] [--async]
+        [--no-auto-rebalance] [--encryption-key=ENCRYPTION_KEY]
+        [--labels=[KEY=VALUE,...]] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Create an Apache Kafka for BigQuery cluster.
+
+EXAMPLES
+    To create a cluster, run the following:
+
+        $ gcloud beta managed-kafka clusters create mycluster \
+            --location=us-central1 --cpu=3 --memory=3GiB \
+            --subnets=projects/PROJECT_ID/regions/us-central1/subnetworks/\
+        default
+
+POSITIONAL ARGUMENTS
+     Cluster resource - Identifies the cluster for which the command runs. The
+     arguments in this group can be used to specify the attributes of this
+     resource. (NOTE) Some attributes are not given arguments in this group but
+     can be set in other ways.
+
+     To set the project attribute:
+      ◆ provide the argument cluster on the command line with a fully
+        specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       CLUSTER
+          ID of the cluster or fully qualified identifier for the cluster.
+
+          To set the cluster attribute:
+          ▸ provide the argument cluster on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --location=LOCATION
+          ID of the location of the Apache Kafka for BigQuery resource. See
+          https://cloud.google.com/managed-kafka/docs/locations for a list of
+          supported locations.
+
+          To set the location attribute:
+          ▸ provide the argument cluster on the command line with a fully
+            specified name;
+          ▸ provide the argument --location on the command line.
+
+REQUIRED FLAGS
+     --cpu=CPU
+        The number of vCPUs to provision for the cluster. The minimum is 3.
+
+     --memory=MEMORY
+        The memory to provision for the cluster in bytes. The value must be
+        between 1 GiB and 8 GiB per vCPU. Ex. 1024Mi, 4Gi.
+
+     --subnets=[SUBNETS,...]
+        VPC subnets from which the cluster is accessible. Both broker and
+        bootstrap server IP addresses and DNS entries are automatically created
+        in each subnet. The subnet must be located in the same region as the
+        cluster. The project may differ. A minimum of 1 subnet is required. A
+        maximum of 10 subnets can be specified. Use commas to separate multiple
+        subnets. The name of the subnet must be in the format
+        projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET.
+
+OPTIONAL FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+     --auto-rebalance
+        Whether the automatic rebalancing is enabled. If automatic rebalancing
+        is enabled, topic partitions are rebalanced among brokers when the
+        number of CPUs in the cluster changes. Automatic rebalancing is enabled
+        by default. Use --no-auto-rebalance to disable this flag. Enabled by
+        default, use --no-auto-rebalance to disable.
+
+     --encryption-key=ENCRYPTION_KEY
+        The relative resource path of the Cloud KMS key to use for encryption
+        in the form:
+        projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY.
+        The key must be located in the same region as the cluster. The key
+        cannot be changed once set.
+
+     --labels=[KEY=VALUE,...]
+        List of label KEY=VALUE pairs to add. Keys must start with a lowercase
+        character and contain only hyphens (-), underscores (), lowercase
+        characters, and numbers. Values must contain only hyphens (-),
+        underscores (), lowercase characters, and numbers.
+
+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.
+
+API REFERENCE
+    This command uses the managedkafka/v1 API. The full documentation for this
+    API can be found at: https://cloud.google.com/managed-kafka
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha managed-kafka clusters create
+

gcloud/beta/managed-kafka/clusters/delete

@@ -0,0 +1,74 @@
+NAME
+    gcloud beta managed-kafka clusters delete - delete an Apache Kafka for
+        BigQuery cluster
+
+SYNOPSIS
+    gcloud beta managed-kafka clusters delete (CLUSTER : --location=LOCATION)
+        [--async] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Delete an Apache Kafka for BigQuery cluster.
+
+EXAMPLES
+    To delete a cluster named mycluster located in us-central1, run the
+    following:
+
+        $ gcloud beta managed-kafka clusters delete mycluster \
+            --location=us-central1
+
+POSITIONAL ARGUMENTS
+     Cluster resource - Identifies the cluster for deletion. The arguments in
+     this group can be used to specify the attributes of this resource. (NOTE)
+     Some attributes are not given arguments in this group but can be set in
+     other ways.
+
+     To set the project attribute:
+      ◆ provide the argument cluster on the command line with a fully
+        specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       CLUSTER
+          ID of the cluster or fully qualified identifier for the cluster.
+
+          To set the cluster attribute:
+          ▸ provide the argument cluster on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --location=LOCATION
+          ID of the location of the Apache Kafka for BigQuery resource. See
+          https://cloud.google.com/managed-kafka/docs/locations for a list of
+          supported locations.
+
+          To set the location attribute:
+          ▸ provide the argument cluster on the command line with a fully
+            specified name;
+          ▸ provide the argument --location on the command line.
+
+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.
+
+API REFERENCE
+    This command uses the managedkafka/v1 API. The full documentation for this
+    API can be found at: https://cloud.google.com/managed-kafka
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha managed-kafka clusters delete
+

gcloud/beta/managed-kafka/clusters/describe

@@ -0,0 +1,69 @@
+NAME
+    gcloud beta managed-kafka clusters describe - describe an Apache Kafka for
+        BigQuery cluster
+
+SYNOPSIS
+    gcloud beta managed-kafka clusters describe (CLUSTER : --location=LOCATION)
+        [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Describe an Apache Kafka for BigQuery cluster.
+
+EXAMPLES
+    To describe a cluster named mycluster located in us-central1, run the
+    following:
+
+        $ gcloud beta managed-kafka clusters describe mycluster \
+            --location=us-central1
+
+POSITIONAL ARGUMENTS
+     Cluster resource - Identifies the cluster for details to be displayed. The
+     arguments in this group can be used to specify the attributes of this
+     resource. (NOTE) Some attributes are not given arguments in this group but
+     can be set in other ways.
+
+     To set the project attribute:
+      ◆ provide the argument cluster on the command line with a fully
+        specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       CLUSTER
+          ID of the cluster or fully qualified identifier for the cluster.
+
+          To set the cluster attribute:
+          ▸ provide the argument cluster on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --location=LOCATION
+          ID of the location of the Apache Kafka for BigQuery resource. See
+          https://cloud.google.com/managed-kafka/docs/locations for a list of
+          supported locations.
+
+          To set the location attribute:
+          ▸ provide the argument cluster on the command line with a fully
+            specified name;
+          ▸ provide the argument --location on the command line.
+
+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.
+
+API REFERENCE
+    This command uses the managedkafka/v1 API. The full documentation for this
+    API can be found at: https://cloud.google.com/managed-kafka
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha managed-kafka clusters describe
+

gcloud/beta/managed-kafka/clusters/help

@@ -0,0 +1,39 @@
+NAME
+    gcloud beta managed-kafka clusters - administer Apache Kafka for BigQuery
+        clusters
+
+SYNOPSIS
+    gcloud beta managed-kafka clusters COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Administer Apache Kafka for BigQuery 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
+        (BETA) Create an Apache Kafka for BigQuery cluster.
+
+     delete
+        (BETA) Delete an Apache Kafka for BigQuery cluster.
+
+     describe
+        (BETA) Describe an Apache Kafka for BigQuery cluster.
+
+     list
+        (BETA) List all Apache Kafka for BigQuery clusters in a given location.
+
+     update
+        (BETA) Update an Apache Kafka for BigQuery cluster.
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha managed-kafka clusters
+

gcloud/beta/managed-kafka/clusters/list

@@ -0,0 +1,82 @@
+NAME
+    gcloud beta managed-kafka clusters list - list all Apache Kafka for
+        BigQuery clusters in a given location
+
+SYNOPSIS
+    gcloud beta managed-kafka clusters list --location=LOCATION
+        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
+        [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) List all Apache Kafka for BigQuery clusters in a given location. To
+    specify the maximum number of clusters to list, use the --limit flag.
+
+EXAMPLES
+    To list all clusters in a given location, such as us-central1, run the
+    following:
+
+        $ gcloud beta managed-kafka clusters list --location=us-central1
+
+REQUIRED FLAGS
+     Location resource - Identifies the region which contains all the clusters
+     to be listed. This represents a Cloud resource. (NOTE) Some attributes are
+     not given arguments in this group but can be set in other ways.
+
+     To set the project attribute:
+      ◆ provide the argument --location on the command line with a fully
+        specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       --location=LOCATION
+          ID of the location or fully qualified identifier for the location.
+
+          To set the location attribute:
+          ▸ provide the argument --location on the command line.
+
+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.
+
+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.
+
+API REFERENCE
+    This command uses the managedkafka/v1 API. The full documentation for this
+    API can be found at: https://cloud.google.com/managed-kafka
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha managed-kafka clusters list
+

gcloud/beta/managed-kafka/clusters/update

@@ -0,0 +1,108 @@
+NAME
+    gcloud beta managed-kafka clusters update - update an Apache Kafka for
+        BigQuery cluster
+
+SYNOPSIS
+    gcloud beta managed-kafka clusters update (CLUSTER : --location=LOCATION)
+        (--no-auto-rebalance --cpu=CPU
+          --labels=[KEY=VALUE,...] --memory=MEMORY --subnets=[SUBNETS,...])
+        [--async] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (BETA) Update an Apache Kafka for BigQuery cluster.
+
+EXAMPLES
+    To update an attribute in a cluster named mycluster located in us-central1,
+    such as the CPU, run the following:
+
+        $ gcloud beta managed-kafka clusters update mycluster \
+            --location=us-central1 --cpu=3
+
+POSITIONAL ARGUMENTS
+     Cluster resource - Identifies the cluster to be updated. The arguments in
+     this group can be used to specify the attributes of this resource. (NOTE)
+     Some attributes are not given arguments in this group but can be set in
+     other ways.
+
+     To set the project attribute:
+      ◆ provide the argument cluster on the command line with a fully
+        specified name;
+      ◆ provide the argument --project on the command line;
+      ◆ set the property core/project.
+
+     This must be specified.
+
+       CLUSTER
+          ID of the cluster or fully qualified identifier for the cluster.
+
+          To set the cluster attribute:
+          ▸ provide the argument cluster on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --location=LOCATION
+          ID of the location of the Apache Kafka for BigQuery resource. See
+          https://cloud.google.com/managed-kafka/docs/locations for a list of
+          supported locations.
+
+          To set the location attribute:
+          ▸ provide the argument cluster on the command line with a fully
+            specified name;
+          ▸ provide the argument --location on the command line.
+
+REQUIRED FLAGS
+     At least one of these must be specified:
+
+       --auto-rebalance
+          Whether the automatic rebalancing is enabled. If automatic
+          rebalancing is enabled, topic partitions are rebalanced among brokers
+          when the number of CPUs in the cluster changes. Automatic rebalancing
+          is enabled by default. Use --no-auto-rebalance to disable this flag.
+          Enabled by default, use --no-auto-rebalance to disable.
+
+       --cpu=CPU
+          The number of vCPUs to provision for the cluster. The minimum is 3.
+
+       --labels=[KEY=VALUE,...]
+          List of label KEY=VALUE pairs to add. Keys must start with a
+          lowercase character and contain only hyphens (-), underscores (),
+          lowercase characters, and numbers. Values must contain only hyphens
+          (-), underscores (), lowercase characters, and numbers.
+
+       --memory=MEMORY
+          The memory to provision for the cluster in bytes. The value must be
+          between 1 GiB and 8 GiB per vCPU. Ex. 1024Mi, 4Gi.
+
+       --subnets=[SUBNETS,...]
+          VPC subnets from which the cluster is accessible. Both broker and
+          bootstrap server IP addresses and DNS entries are automatically
+          created in each subnet. The subnet must be located in the same region
+          as the cluster. The project may differ. A minimum of 1 subnet is
+          required. A maximum of 10 subnets can be specified. Use commas to
+          separate multiple subnets. The name of the subnet must be in the
+          format projects/PROJECT_ID/regions/REGION/subnetworks/SUBNET.
+
+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.
+
+API REFERENCE
+    This command uses the managedkafka/v1 API. The full documentation for this
+    API can be found at: https://cloud.google.com/managed-kafka
+
+NOTES
+    This command is currently in beta and might change without notice. This
+    variant is also available:
+
+        $ gcloud alpha managed-kafka clusters update
+