1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-13 08:27:05 +00:00
gcloud-help/gcloud/alpha/immersive-stream/xr/instances/update
2023-12-06 10:10:36 +00:00

146 lines
5.8 KiB
Text

NAME
gcloud alpha immersive-stream xr instances update - update an Immersive
Stream for XR service instance
SYNOPSIS
gcloud alpha immersive-stream xr instances update
(INSTANCE : --location=LOCATION)
(--add-region=[autoscaling_buffer=AUTOSCALING_BUFFER],
[autoscaling_min_capacity=AUTOSCALING_MIN_CAPACITY],
[capacity=CAPACITY],
[enable_autoscaling=ENABLE_AUTOSCALING],[region=REGION]
| --fallback-url=FALLBACK_URL | --remove-region=REMOVE_REGION
| --update-region=[autoscaling_buffer=AUTOSCALING_BUFFER],
[autoscaling_min_capacity=AUTOSCALING_MIN_CAPACITY],
[capacity=CAPACITY],
[enable_autoscaling=ENABLE_AUTOSCALING],[region=REGION]
| --version=VERSION) [--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Update an Immersive Stream for XR service instance. This command
can be used to update one of the following:
▪ the capacity for an existing region of the service instance
▪ the content build version served by the instance
▪ the fallback url to redirect users to when the service instance is
unable to provide the streaming experience
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.
EXAMPLES
To update the service instance my-instance to have capacity 2 for an
existing region us-west1, run:
$ gcloud alpha immersive-stream xr instances update my-instance \
--update-region=region=us-west1,capacity=2
To update the service instance my-instance to have capacity 1 for a new
region us-east4, run:
$ gcloud alpha immersive-stream xr instances update my-instance \
--add-region=region=us-east4,capacity=1
To update the service instance my-instance to remove the existing region
us-east4, run:
$ gcloud alpha immersive-stream xr instances update my-instance \
--remove-region=us-east4
To update the service instance my-instance to serve content version
my-version, run:
$ gcloud alpha immersive-stream xr instances update my-instance \
--version=my-version
To update the service instance my-instance to use fallback url
https://www.google.com, run:
$ gcloud alpha immersive-stream xr instances update my-instance \
--fallback-url="https://www.google.com"
POSITIONAL ARGUMENTS
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 project attribute:
◆ provide the argument instance 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.
INSTANCE
ID of the instance or fully qualified identifier for the instance.
To set the name attribute:
▸ provide the argument instance on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--location=LOCATION
Google Cloud location for the instance.
To set the location attribute:
▸ provide the argument instance on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ location is always global.
REQUIRED FLAGS
Update options
Exactly one of these must be specified:
--add-region=[autoscaling_buffer=AUTOSCALING_BUFFER],[autoscaling_min_capacity=AUTOSCALING_MIN_CAPACITY],[capacity=CAPACITY],[enable_autoscaling=ENABLE_AUTOSCALING],[region=REGION]
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.
--fallback-url=FALLBACK_URL
Fallback url to redirect users to when this service instance is
unable to provide the streaming experience
--remove-region=REMOVE_REGION
Region to remove
--update-region=[autoscaling_buffer=AUTOSCALING_BUFFER],[autoscaling_min_capacity=AUTOSCALING_MIN_CAPACITY],[capacity=CAPACITY],[enable_autoscaling=ENABLE_AUTOSCALING],[region=REGION]
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.
--version=VERSION
Build version tag of the content served by this instance
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.
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. This variant is also available:
$ gcloud immersive-stream xr instances update