File: //snap/google-cloud-cli/current/help/man/man1/gcloud_immersive-stream_xr_instances_update.1
.TH "GCLOUD_IMMERSIVE\-STREAM_XR_INSTANCES_UPDATE" 1
.SH "NAME"
.HP
gcloud immersive\-stream xr instances update \- update an Immersive Stream for XR service instance
.SH "SYNOPSIS"
.HP
\f5gcloud immersive\-stream xr instances update\fR (\fIINSTANCE\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) (\fB\-\-add\-region\fR=[\fIautoscaling_buffer\fR=\fIAUTOSCALING_BUFFER\fR],[\fIautoscaling_min_capacity\fR=\fIAUTOSCALING_MIN_CAPACITY\fR],[\fIcapacity\fR=\fICAPACITY\fR],[\fIenable_autoscaling\fR=\fIENABLE_AUTOSCALING\fR],[\fIregion\fR=\fIREGION\fR]\ |\ \fB\-\-fallback\-url\fR=\fIFALLBACK_URL\fR\ |\ \fB\-\-remove\-region\fR=\fIREMOVE_REGION\fR\ |\ \fB\-\-update\-region\fR=[\fIautoscaling_buffer\fR=\fIAUTOSCALING_BUFFER\fR],[\fIautoscaling_min_capacity\fR=\fIAUTOSCALING_MIN_CAPACITY\fR],[\fIcapacity\fR=\fICAPACITY\fR],[\fIenable_autoscaling\fR=\fIENABLE_AUTOSCALING\fR],[\fIregion\fR=\fIREGION\fR]\ |\ \fB\-\-version\fR=\fIVERSION\fR) [\fB\-\-async\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
Update an Immersive Stream for XR service instance. This command can be used to
update one of the following:
.RS 2m
.IP "\(bu" 2m
the capacity for an existing region of the service instance
.IP "\(bu" 2m
the content build version served by the instance
.IP "\(bu" 2m
the fallback url to redirect users to when the service instance is unable to
provide the streaming experience
.RE
.sp
If updating the capacity, only one region may be updated for each command
execution, and the new capacity may not be 0 or exceed the quota limit.
.SH "EXAMPLES"
To update the service instance \f5my\-instance\fR to have capacity 2 for an
existing region us\-west1, run:
.RS 2m
$ gcloud immersive\-stream xr instances update my\-instance \e
\-\-update\-region=region=us\-west1,capacity=2
.RE
To update the service instance \f5my\-instance\fR to have capacity 1 for a new
region us\-east4, run:
.RS 2m
$ gcloud immersive\-stream xr instances update my\-instance \e
\-\-add\-region=region=us\-east4,capacity=1
.RE
To update the service instance \f5my\-instance\fR to remove the existing region
us\-east4, run:
.RS 2m
$ gcloud immersive\-stream xr instances update my\-instance \e
\-\-remove\-region=us\-east4
.RE
To update the service instance \f5my\-instance\fR to serve content version
\f5my\-version\fR, run:
.RS 2m
$ gcloud immersive\-stream xr instances update my\-instance \e
\-\-version=my\-version
.RE
To update the service instance \f5my\-instance\fR to use fallback url
\f5https://www.google.com\fR, run:
.RS 2m
$ gcloud immersive\-stream xr instances update my\-instance \e
\-\-fallback\-url="https://www.google.com"
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Instance resource \- Immersive Stream for XR service instance 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 \f5instance\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
\fIINSTANCE\fR
ID of the instance or fully qualified identifier for the instance.
To set the \f5name\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\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
Google Cloud location for the instance.
To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5instance\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
location is always global.
.RE
.sp
.RE
.RE
.sp
.SH "REQUIRED FLAGS"
.RS 2m
.TP 2m
Update options
Exactly one of these must be specified:
.RS 2m
.TP 2m
\fB\-\-add\-region\fR=[\fIautoscaling_buffer\fR=\fIAUTOSCALING_BUFFER\fR],[\fIautoscaling_min_capacity\fR=\fIAUTOSCALING_MIN_CAPACITY\fR],[\fIcapacity\fR=\fICAPACITY\fR],[\fIenable_autoscaling\fR=\fIENABLE_AUTOSCALING\fR],[\fIregion\fR=\fIREGION\fR]
Flag used to specify region and capacity required for the service instance's
availability.
\'region' is the region in which the instance is deployed.
\'capacity' is the maxium number of concurrent streaming sessions that the
instance can support in the given region.
.TP 2m
\fB\-\-fallback\-url\fR=\fIFALLBACK_URL\fR
Fallback url to redirect users to when this service instance is unable to
provide the streaming experience
.TP 2m
\fB\-\-remove\-region\fR=\fIREMOVE_REGION\fR
Region to remove
.TP 2m
\fB\-\-update\-region\fR=[\fIautoscaling_buffer\fR=\fIAUTOSCALING_BUFFER\fR],[\fIautoscaling_min_capacity\fR=\fIAUTOSCALING_MIN_CAPACITY\fR],[\fIcapacity\fR=\fICAPACITY\fR],[\fIenable_autoscaling\fR=\fIENABLE_AUTOSCALING\fR],[\fIregion\fR=\fIREGION\fR]
Flag used to specify region and capacity required for the service instance's
availability.
\'region' is the region in which the instance is deployed.
\'capacity' is the maxium number of concurrent streaming sessions that the
instance can support in the given region.
.TP 2m
\fB\-\-version\fR=\fIVERSION\fR
Build version tag of the content served by this instance
.RE
.RE
.sp
.SH "OPTIONAL FLAGS"
.RS 2m
.TP 2m
\fB\-\-async\fR
Return immediately, without waiting for the operation in progress to complete.
.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 "NOTES"
This variant is also available:
.RS 2m
$ gcloud alpha immersive\-stream xr instances update
.RE