File: //snap/google-cloud-cli/current/help/man/man1/gcloud_alpha_managed-kafka_clusters_describe.1
.TH "GCLOUD_ALPHA_MANAGED\-KAFKA_CLUSTERS_DESCRIBE" 1
.SH "NAME"
.HP
gcloud alpha managed\-kafka clusters describe \- describe a Managed Service for Apache Kafka cluster
.SH "SYNOPSIS"
.HP
\f5gcloud alpha managed\-kafka clusters describe\fR (\fICLUSTER\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-full\-view\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR Describe a Managed Service for Apache Kafka cluster.
.SH "EXAMPLES"
To describe a cluster named mycluster located in us\-central1, run the
following:
.RS 2m
$ gcloud alpha managed\-kafka clusters describe mycluster \e
\-\-location=us\-central1
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5cluster\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp
This must be specified.
.RS 2m
.TP 2m
\fICLUSTER\fR
ID of the cluster or fully qualified identifier for the cluster.
To set the \f5cluster\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5cluster\fR on the command line.
.RE
.sp
This positional argument must be specified if any of the other arguments in this
group are specified.
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR
ID of the location of the Managed Service for Apache Kafka resource. See
https://cloud.google.com/managed\-service\-for\-apache\-kafka/docs/locations for
a list of supported locations.
To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5cluster\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp
.RE
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-full\-view\fR
Whether full cluster view is returned. If provided, the cluster view will
include everything, including data fetched from the Kafka cluster source of
truth. If not provided, the API will default to the basic view that only
includes the basic metadata of the cluster.
.RE
.sp
.SH "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 \fB$ gcloud help\fR for details.
.SH "API REFERENCE"
This command uses the \fBmanagedkafka/v1\fR API. The full documentation for this
API can be found at:
https://cloud.google.com/managed\-service\-for\-apache\-kafka/docs
.SH "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. These variants are also available:
.RS 2m
$ gcloud managed\-kafka clusters describe
.RE
.RS 2m
$ gcloud beta managed\-kafka clusters describe
.RE