Google Cloud Video Live Stream V1 Client - Class Pool (0.6.2)

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

Pool resource defines the configuration of Live Stream pools for a specific location. Currently we support only one pool resource per project per location. After the creation of the first input, a default pool is created automatically at "projects/{project}/locations/{location}/pools/default".

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

Namespace

Google \ Cloud \ Video \ LiveStream \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The resource name of the pool, in the form of: projects/{project}/locations/{location}/pools/{poolId}.

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

↳ network_config Google\Cloud\Video\LiveStream\V1\Pool\NetworkConfig

Network configuration for the pool.

getName

The resource name of the pool, in the form of: projects/{project}/locations/{location}/pools/{poolId}.

Returns
TypeDescription
string

setName

The resource name of the pool, in the form of: projects/{project}/locations/{location}/pools/{poolId}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. The creation time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. The update time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The update time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLabels

User-defined key/value metadata.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

User-defined key/value metadata.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getNetworkConfig

Network configuration for the pool.

Returns
TypeDescription
Google\Cloud\Video\LiveStream\V1\Pool\NetworkConfig|null

hasNetworkConfig

clearNetworkConfig

setNetworkConfig

Network configuration for the pool.

Parameter
NameDescription
var Google\Cloud\Video\LiveStream\V1\Pool\NetworkConfig
Returns
TypeDescription
$this