File: //snap/google-cloud-cli/current/help/man/man1/gcloud_beta_saas-runtime_units_update.1
.TH "GCLOUD_BETA_SAAS\-RUNTIME_UNITS_UPDATE" 1
.SH "NAME"
.HP
gcloud beta saas\-runtime units update \- update a Unit
.SH "SYNOPSIS"
.HP
\f5gcloud beta saas\-runtime units update\fR \fIUNIT\fR [\fB\-\-location\fR=\fILOCATION\fR] [\fB\-\-maintenance\-pinned\-until\-time\fR=\fIMAINTENANCE_PINNED_UNTIL_TIME\fR] [\fB\-\-clear\-tenant\fR\ |\ \fB\-\-tenant\fR=\fITENANT\fR] [\fB\-\-clear\-unit\-kind\fR\ |\ \fB\-\-unit\-kind\fR=\fIUNIT_KIND\fR] [\fB\-\-labels\fR=[\fILABELS\fR,...]\ |\ \fB\-\-update\-labels\fR=[\fIUPDATE_LABELS\fR,...]\ \fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=\fIREMOVE_LABELS\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(BETA)\fR Update a Unit
.SH "EXAMPLES"
To update the Unit, run:
.RS 2m
$ gcloud beta saas\-runtime units update
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Unit resource \- Identifier. The resource name (full URI of the resource)
following the standard naming scheme:
.RS 2m
"projects/{project}/locations/{location}/units/{unit}" This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.
.RE
To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5unit\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
To set the \f5location\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5unit\fR on the command line with a fully specified name;
.IP "\(em" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp
This must be specified.
.RS 2m
.TP 2m
\fIUNIT\fR
ID of the unit or fully qualified identifier for the unit.
To set the \f5unit\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5unit\fR on the command line.
.RE
.sp
.RE
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR
For resources [unit, tenant, unit\-kind], provides fallback value for resource
location attribute. When the resource's full URI path is not provided, location
will fallback to this flag value.
.TP 2m
Captures requested directives for performing future maintenance on the unit.
This includes a request for the unit to skip maintenance for a period of time
and remain pinned to its current release as well as controls for postponing
maintenance scheduled in future.
.RS 2m
.TP 2m
\fB\-\-maintenance\-pinned\-until\-time\fR=\fIMAINTENANCE_PINNED_UNTIL_TIME\fR
If present, it fixes the release on the unit until the given time; i.e. changes
to the release field will be rejected. Rollouts should and will also respect
this by not requesting an upgrade in the first place.
.RE
.sp
.TP 2m
Update tenant.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-clear\-tenant\fR
Clear tenant value and set to null.
.TP 2m
Tenant resource \- Set tenant to new value.
Reference to the Saas Tenant resource this unit belongs to. This for example
informs the maintenance policies to use for scheduling future updates on a unit.
(optional and immutable once created) 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 \f5project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-tenant\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp
To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-tenant\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
.RS 2m
.TP 2m
\fB\-\-tenant\fR=\fITENANT\fR
ID of the tenant or fully qualified identifier for the tenant.
To set the \f5tenant\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-tenant\fR on the command line.
.RE
.sp
.RE
.RE
.sp
.TP 2m
Update unit_kind.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-clear\-unit\-kind\fR
Clear unit_kind value and set to null.
.TP 2m
UnitKind resource \- Set unit_kind to new value.
Reference to the UnitKind this Unit belongs to. Immutable once set. 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 \f5project\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-unit\-kind\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(bu" 2m
set the property \f5core/project\fR.
.RE
.sp
To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-unit\-kind\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
.RS 2m
.TP 2m
\fB\-\-unit\-kind\fR=\fIUNIT_KIND\fR
ID of the unitKind or fully qualified identifier for the unitKind.
To set the \f5unit\-kind\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-unit\-kind\fR on the command line.
.RE
.sp
.RE
.RE
.sp
.TP 2m
Update labels.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-labels\fR=[\fILABELS\fR,...]
Set labels to new value. The labels on the resource, which can be used for
categorization. similar to Kubernetes resource labels.
.RS 2m
.TP 2m
\fBKEY\fR
Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers.
.TP 2m
\fBVALUE\fR
Values must contain only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase
characters, and numbers.
.RE
.sp
\fBShorthand Example:\fR
.RS 2m
\-\-labels=string=string
.RE
\fBJSON Example:\fR
.RS 2m
\-\-labels='{"string": "string"}'
.RE
\fBFile Example:\fR
.RS 2m
\-\-labels=path_to_file.(yaml|json)
.RE
.TP 2m
\fB\-\-update\-labels\fR=[\fIUPDATE_LABELS\fR,...]
Update labels value or add key value pair. The labels on the resource, which can
be used for categorization. similar to Kubernetes resource labels.
.RS 2m
.TP 2m
\fBKEY\fR
Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers.
.TP 2m
\fBVALUE\fR
Values must contain only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase
characters, and numbers.
.RE
.sp
\fBShorthand Example:\fR
.RS 2m
\-\-update\-labels=string=string
.RE
\fBJSON Example:\fR
.RS 2m
\-\-update\-labels='{"string": "string"}'
.RE
\fBFile Example:\fR
.RS 2m
\-\-update\-labels=path_to_file.(yaml|json)
.RE
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR
Clear labels value and set to empty map.
.TP 2m
\fB\-\-remove\-labels\fR=\fIREMOVE_LABELS\fR
Remove existing value from map labels. Sets \f5remove_labels\fR value.
\fBShorthand Example:\fR
.RS 2m
\-\-remove\-labels=string,string
.RE
\fBJSON Example:\fR
.RS 2m
\-\-remove\-labels=["string"]
.RE
\fBFile Example:\fR
.RS 2m
\-\-remove\-labels=path_to_file.(yaml|json)
.RE
.RE
.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 \fBsaasservicemgmt/v1beta1\fR API. The full documentation
for this API can be found at: https://cloud.google.com/saas\-runtime/docs
.SH "NOTES"
This command is currently in beta and might change without notice.