Method: projects.locations.streamInstances.rollout

Stay organized with collections Save and categorize content based on your preferences.

Roll out an service instance with the content of a user-specified version in the instance deployment realms.

The returned Operation can be used to track the rollout status by polling operations.get. The Operation will complete when the rollout is complete.

Returns [StreamInstance] in the Operation.response field on successful completion.

HTTP request

POST https://stream.googleapis.com/v1alpha1/{name=projects/*/locations/*/streamInstances/*}:rollout

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Canonical resource name of the instance.

Request body

The request body contains data with the following structure:

JSON representation
{
  "contentVersionTag": string,
  "realms": [
    enum (Realm)
  ],
  "requestId": string
}
Fields
contentVersionTag

string

Required. The user-specified version tag of the content to be served by the instance after rollout.

realms[]

enum (Realm)

Required. Realms of the instance rollout.

requestId

string

Optional. A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a requestId is provided."

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.