gcloud immersive-stream xr instances create Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud immersive-stream xr instances create - create an Immersive Stream for XR service instance
- SYNOPSIS
gcloud immersive-stream xr instances createINSTANCE--add-region=[autoscaling_buffer=AUTOSCALING_BUFFER],[autoscaling_min_capacity=AUTOSCALING_MIN_CAPACITY],[capacity=CAPACITY],[enable_autoscaling=ENABLE_AUTOSCALING],[region=REGION]--version=VERSION(--content=CONTENT:--location=LOCATION)[--async][--fallback-url=FALLBACK_URL][--gpu-class=GPU_CLASS][--mode=MODE][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Create an Immersive Stream for XR service instance.
- EXAMPLES
- To create a service instance called
my-instanceserving contentmy-contentwith versionmy-versionthat hasavailablilty for 2 concurent sessions in us-west1 region and 3 concurrentsessions in us-east4 region, run:gcloudimmersive-streamxrinstancescreatemy-instance--content=my-content--version=my-version--add-region=region=us-west1,capacity=2--add-region=region=us-east4,capacity=3Optionally, a fallback url may be specified. Users will be redirected to thisfallback url when the service instance is unable to provide the streamingexperience. To create a service instance called
my-instanceservingcontentmy-contentwith versionmy-versionthat hasavailablilty for 2 concurent sessions in us-west1 and uses fallback urlhttps://www.google.comrun:gcloudimmersive-streamxrinstancescreatemy-instance--content=my-content--version=my-version--add-region=region=us-west1,capacity=2--fallback-url="https://www.google.com"Bydefault,theinstanceiscreatedwithmode=ar,whichsupportsboth3DandARexperiences.Instancescanalsobeconfiguredtouse3D-onlymode.Thisconfigurationcannotbeupdatedlater.Touse3D-onlymode,include:
--mode=3dBydefault,theinstanceiscreatedwithgpu-class=t4.ThisusestheNVIDIAT4GPUfortheinstance.InstancescanalsobeconfiguredtouseNVIDIAL4GPUsatcreation.NotethatonlycertainregionsareavailableforL4,andonly3D-onlymodeissupported.Thisconfigurationcannotbeupdatedlater.TouseNVIDIAL4GPUfortheinstance,include:
--gpu-class=l4 - POSITIONAL ARGUMENTS
INSTANCE- Name of the instance to be created
- REQUIRED FLAGS
--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'savailability.
'region'istheregioninwhichtheinstanceisdeployed.
'capacity'isthemaxiumnumberofconcurrentstreamingsessionsthattheinstancecansupportinthegivenregion.
This is a repeatable flag.
--version=VERSION- Build version tag of the content served by this instance
- Content resource - Immersive Stream for XR content resource served by theinstance. The arguments in this group can be used to specify the attributes ofthis resource. (NOTE) Some attributes are not given arguments in this group butcan be set in other ways.
To set the
projectattribute:- provide the argument
--contenton the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
--content=CONTENT- ID of the content or fully qualified identifier for the content.
To set the
nameattribute:- provide the argument
--contenton the command line.
This flag argument must be specified if any of the other arguments in this groupare specified.
- provide the argument
--location=LOCATION- Google Cloud location for the content.
To set the
locationattribute:- provide the argument
--contenton the command line with a fullyspecified name; - provide the argument
--locationon the command line; - location is always global.
- provide the argument
- provide the argument
- OPTIONAL FLAGS
--async- Return immediately, without waiting for the operation in progress to complete.
--fallback-url=FALLBACK_URL- Fallback url to redirect users to when this service instance is unable toprovide the streaming experience
--gpu-class=GPU_CLASS- The class of GPU that is used by this service instance
--mode=MODE- The rendering mode that is supported by this service instance
- 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 helpfor details. - NOTES
- This variant is also available:
gcloudalphaimmersive-streamxrinstancescreate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-22 UTC.