REST Resource: projects.locations.streamInstances

Resource: StreamInstance

Message describing StreamInstance object Next ID: 13

JSON representation
{
  "name": string,
  "content": string,
  "contentBuildVersion": {
    object (BuildVersion)
  },
  "apiEndpoint": string,
  "apiKey": string,
  "locationConfigs": {
    string: {
      object (LocationConfig)
    },
    ...
  },
  "lifecycleState": {
    object (LifecycleState)
  },
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "streamConfig": {
    object (StreamConfig)
  }
}
Fields
name

string

name of resource

content

string

The content that this instance serves.

contentBuildVersion

object (BuildVersion)

The user-specified version tag and build ID of the content served.

apiEndpoint

string

Output only. The API endpoint to which an Stream client can connect to request a streaming session.

apiKey

string

Output only. The API key that an Stream client must use when requesting a streaming session.

locationConfigs

map (key: string, value: object (LocationConfig))

Deployment configuration of the instance by locations (only regions are supported now). Map keys are regions in the string form. Example: { "us-central1": { "capacity": 1 }, "europe-west4": { "capacity": 2 } }.

lifecycleState

object (LifecycleState)

Output only. Current status of the instance.

createTime

string (Timestamp format)

Output only. [Output only] Create time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. [Output only] Update time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Labels as key value pairs

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

streamConfig

object (StreamConfig)

Optional. An optional config data to configure the client UI.

StreamConfig

Describes the optional configuration payload that the customer wants to set up with for the instance.

JSON representation
{
  "fallbackUri": string
}
Fields
fallbackUri

string

User-specified fallback uri that should be launched from the client when there is a streaming server stock-out.

Methods

create

Creates a new StreamInstance that manages the turnup and rollout of the streaming service for a given StreamContent.

delete

Deletes a single StreamInstance.

get

Gets details of a single StreamInstance.

list

Lists StreamInstances in a given project and location.

patch

Updates the parameters of a single StreamInstance.