Google Cloud Video Live Stream V1 Client - Class Asset (0.7.3)

Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class Asset.

An asset represents a video or an image.

Generated from protobuf message google.cloud.video.livestream.v1.Asset

Namespace

Google \ Cloud \ Video \ LiveStream \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

The resource name of the asset, in the form of: projects/{project}/locations/{location}/assets/{assetId}.

↳ create_time Google\Protobuf\Timestamp

Output only. The creation time.

↳ update_time Google\Protobuf\Timestamp

Output only. The update time.

↳ labels array|Google\Protobuf\Internal\MapField

User-defined key/value metadata.

↳ video Google\Cloud\Video\LiveStream\V1\Asset\VideoAsset

VideoAsset represents a video.

↳ image Google\Cloud\Video\LiveStream\V1\Asset\ImageAsset

ImageAsset represents an image.

↳ crc32c string

Based64-encoded CRC32c checksum of the asset file. For more information, see the crc32c checksum of the Cloud Storage Objects resource. If crc32c is omitted or left empty when the asset is created, this field is filled by the crc32c checksum of the Cloud Storage object indicated by [VideoAsset.uri] or [ImageAsset.uri]. If crc32c is set, the asset can't be created if the crc32c value does not match with the crc32c checksum of the Cloud Storage object indicated by [VideoAsset.uri] or [ImageAsset.uri].

↳ state int

Output only. The state of the asset resource.

↳ error Google\Rpc\Status

Output only. Only present when state is ERROR. The reason for the error state of the asset.

getName

The resource name of the asset, in the form of: projects/{project}/locations/{location}/assets/{assetId}.

Returns
Type Description
string

setName

The resource name of the asset, in the form of: projects/{project}/locations/{location}/assets/{assetId}.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The creation time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

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

getUpdateTime

Output only. The update time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The update time.

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

getLabels

User-defined key/value metadata.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

User-defined key/value metadata.

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

getVideo

VideoAsset represents a video.

Returns
Type Description
Google\Cloud\Video\LiveStream\V1\Asset\VideoAsset|null

hasVideo

setVideo

VideoAsset represents a video.

Parameter
Name Description
var Google\Cloud\Video\LiveStream\V1\Asset\VideoAsset
Returns
Type Description
$this

getImage

ImageAsset represents an image.

Returns
Type Description
Google\Cloud\Video\LiveStream\V1\Asset\ImageAsset|null

hasImage

setImage

ImageAsset represents an image.

Parameter
Name Description
var Google\Cloud\Video\LiveStream\V1\Asset\ImageAsset
Returns
Type Description
$this

getCrc32C

Based64-encoded CRC32c checksum of the asset file. For more information, see the crc32c checksum of the Cloud Storage Objects resource.

If crc32c is omitted or left empty when the asset is created, this field is filled by the crc32c checksum of the Cloud Storage object indicated by [VideoAsset.uri] or [ImageAsset.uri]. If crc32c is set, the asset can't be created if the crc32c value does not match with the crc32c checksum of the Cloud Storage object indicated by [VideoAsset.uri] or [ImageAsset.uri].

Returns
Type Description
string

setCrc32C

Based64-encoded CRC32c checksum of the asset file. For more information, see the crc32c checksum of the Cloud Storage Objects resource.

If crc32c is omitted or left empty when the asset is created, this field is filled by the crc32c checksum of the Cloud Storage object indicated by [VideoAsset.uri] or [ImageAsset.uri]. If crc32c is set, the asset can't be created if the crc32c value does not match with the crc32c checksum of the Cloud Storage object indicated by [VideoAsset.uri] or [ImageAsset.uri].

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The state of the asset resource.

Returns
Type Description
int

setState

Output only. The state of the asset resource.

Parameter
Name Description
var int
Returns
Type Description
$this

getError

Output only. Only present when state is ERROR. The reason for the error state of the asset.

Returns
Type Description
Google\Rpc\Status|null

hasError

clearError

setError

Output only. Only present when state is ERROR. The reason for the error state of the asset.

Parameter
Name Description
var Google\Rpc\Status
Returns
Type Description
$this

getResource

Returns
Type Description
string