.TH "GCLOUD_BETA_METASTORE_FEDERATIONS_UPDATE" 1



.SH "NAME"
.HP
gcloud beta metastore federations update \- update a Dataproc Metastore federation



.SH "SYNOPSIS"
.HP
\f5gcloud beta metastore federations update\fR (\fIFEDERATION\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) (\fB\-\-update\-backends\fR=\fIRANK\fR=\fIBACKEND\fR\ \fB\-\-clear\-backends\fR\ |\ \fB\-\-remove\-backends\fR=\fIRANK\fR) [\fB\-\-async\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Update the metadata and/or configuration parameters of a Dataproc
Metastore federation.

If run asynchronously with \f5\-\-async\fR, exits after printing one operation
name that can be used to poll the status of the update via:

.RS 2m
gcloud metastore operations describe
.RE



.SH "EXAMPLES"

To update a Dataproc Metastore federation with the name
\f5my\-metastore\-federation\fR in location \f5us\-central\fR with two backends
\f5dpms1\fR and \f5dpms2\fR, run:

.RS 2m
$ gcloud beta metastore federations update my\-metastore\-federation \e
  \-\-location=us\-central1 \e
  \-\-update\-backends=1=dpms:dpms1,2=dpms:projects/my\-project/\e
locations/us\-central1/services/dpms2
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Federation resource \- Arguments and flags that specify the Dataproc Metastore
federation you want to update. 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 \f5federation\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
\fIFEDERATION\fR

ID of the federation or fully qualified identifier for the federation.

To set the \f5federation\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5federation\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

The location of the Dataproc Metastore service.

If not specified, will use \f5default\fR metastore/location.


To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5federation\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5metastore/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

Update the backend metastores by passing key\-value pairs in through the flags.


At least one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-update\-backends\fR=\fIRANK\fR=\fIBACKEND\fR

Comma\-separated list of metastore backends specified as a list of
\f5RANK=BACKEND\fR pairs. For example:
\f51=dpms:dpms1,2=dpms:projects/my\-project/locations/us\-central1/services/dpms2\fR.
\f5RANK\fR represents the rank of the backend metastore and is used to resolve
database name collisions. \f5BACKEND\fR is specified as
\f5METASTORE_TYPE:METASTORE_NAME\fR where \f5METASTORE_TYPE\fR is the type of
backend metastore and \f5METASTORE_NAME\fR is the relative resource name of the
metastore. If only the name of the metastore is specified (e.g. \f5dpms1\fR),
project and location will be inferred from the project and location used to
create the federation.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-backends\fR

Clear existing metastore backends. \f5\-\-clear\-backends\fR must be used with
\f5\-\-update\-backends\fR.

.TP 2m
\fB\-\-remove\-backends\fR=\fIRANK\fR

Comma\-separated list of metastore backend keys to remove with the form
\f5RANK1,RANK2\fR. The Key represents the rank of the backend metastore and is
used to resolve database name collisions. If a \f5RANK\fR does not exist then it
is sliently ignored. If \f5\-\-update\-backends\fR is also specified, then
\f5\-\-remove\-backends\fR is applied first.


.RE
.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud beta metastore federations update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud beta metastore federations update \-\-clear\-labels \e
  \-\-update\-labels foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-labels\fR=[\fIKEY\fR,...]

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.


.RE
.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 \fBmetastore/v1beta\fR API. The full documentation for
this API can be found at: https://cloud.google.com/dataproc\-metastore/docs



.SH "NOTES"

This command is currently in beta and might change without notice. These
variants are also available:

.RS 2m
$ gcloud metastore federations update
.RE

.RS 2m
$ gcloud alpha metastore federations update
.RE