REST Resource: projects.locations.clusters.streams

Resource: Stream

Message describing the Stream object. The Stream and the Event resources are many to many; i.e., each Stream resource can associate to many Event resources and each Event resource can associate to many Stream resources.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "displayName": string,
  "enableHlsPlayback": boolean,
  "mediaWarehouseAsset": string
}
Fields
name

string

Name of the resource.

createTime

string (Timestamp format)

Output only. The create timestamp.

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. The update timestamp.

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" }.

annotations

map (key: string, value: string)

Annotations to allow clients to store small amounts of arbitrary data.

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

displayName

string

The display name for the stream resource.

enableHlsPlayback

boolean

Whether to enable the HLS playback service on this stream.

mediaWarehouseAsset

string

The name of the media warehouse asset for long term storage of stream data. Format: projects/${p_id}/locations/${l_id}/corpora/${c_id}/assets/${a_id} Remain empty if the media warehouse storage is not needed for the stream.

Methods

create

Creates a new Stream in a given project and location.

delete

Deletes a single Stream.

get

Gets details of a single Stream.

getThumbnail

Gets the thumbnail (image snapshot) of a single Stream.

list

Lists Streams in a given project and location.

patch

Updates the parameters of a single Stream.