Google Cloud Vision Ai V1 Client - Class Stream (0.1.0)

Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class 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.

Generated from protobuf message google.cloud.visionai.v1.Stream

Namespace

Google \ Cloud \ VisionAI \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Name of the resource.

↳ create_time Google\Protobuf\Timestamp

Output only. The create timestamp.

↳ update_time Google\Protobuf\Timestamp

Output only. The update timestamp.

↳ labels array|Google\Protobuf\Internal\MapField

Labels as key value pairs.

↳ annotations array|Google\Protobuf\Internal\MapField

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

↳ display_name string

The display name for the stream resource.

↳ enable_hls_playback bool

Whether to enable the HLS playback service on this stream.

↳ media_warehouse_asset 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.

getName

Name of the resource.

Returns
Type Description
string

setName

Name of the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The create timestamp.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The create timestamp.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The update timestamp.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The update timestamp.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

Labels as key value pairs.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Labels as key value pairs.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getAnnotations

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

Returns
Type Description
Google\Protobuf\Internal\MapField

setAnnotations

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

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getDisplayName

The display name for the stream resource.

Returns
Type Description
string

setDisplayName

The display name for the stream resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getEnableHlsPlayback

Whether to enable the HLS playback service on this stream.

Returns
Type Description
bool

setEnableHlsPlayback

Whether to enable the HLS playback service on this stream.

Parameter
Name Description
var bool
Returns
Type Description
$this

getMediaWarehouseAsset

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.

Returns
Type Description
string

setMediaWarehouseAsset

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.

Parameter
Name Description
var string
Returns
Type Description
$this