Google Analytics Admin V1alpha Client - Class DataStream (0.18.1)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class DataStream.

A resource message representing a data stream.

Generated from protobuf message google.analytics.admin.v1alpha.DataStream

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ web_stream_data Google\Analytics\Admin\V1alpha\DataStream\WebStreamData

Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.

↳ android_app_stream_data Google\Analytics\Admin\V1alpha\DataStream\AndroidAppStreamData

Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.

↳ ios_app_stream_data Google\Analytics\Admin\V1alpha\DataStream\IosAppStreamData

Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.

↳ name string

Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"

↳ type int

Required. Immutable. The type of this DataStream resource.

↳ display_name string

Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units.

↳ create_time Google\Protobuf\Timestamp

Output only. Time when this stream was originally created.

↳ update_time Google\Protobuf\Timestamp

Output only. Time when stream payload fields were last updated.

getWebStreamData

Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.

Returns
TypeDescription
Google\Analytics\Admin\V1alpha\DataStream\WebStreamData|null

hasWebStreamData

setWebStreamData

Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.

Parameter
NameDescription
var Google\Analytics\Admin\V1alpha\DataStream\WebStreamData
Returns
TypeDescription
$this

getAndroidAppStreamData

Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.

Returns
TypeDescription
Google\Analytics\Admin\V1alpha\DataStream\AndroidAppStreamData|null

hasAndroidAppStreamData

setAndroidAppStreamData

Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.

Parameter
NameDescription
var Google\Analytics\Admin\V1alpha\DataStream\AndroidAppStreamData
Returns
TypeDescription
$this

getIosAppStreamData

Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.

Returns
TypeDescription
Google\Analytics\Admin\V1alpha\DataStream\IosAppStreamData|null

hasIosAppStreamData

setIosAppStreamData

Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.

Parameter
NameDescription
var Google\Analytics\Admin\V1alpha\DataStream\IosAppStreamData
Returns
TypeDescription
$this

getName

Output only. Resource name of this Data Stream.

Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"

Returns
TypeDescription
string

setName

Output only. Resource name of this Data Stream.

Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

Required. Immutable. The type of this DataStream resource.

Returns
TypeDescription
int

setType

Required. Immutable. The type of this DataStream resource.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDisplayName

Human-readable display name for the Data Stream.

Required for web data streams. The max allowed display name length is 255 UTF-16 code units.

Returns
TypeDescription
string

setDisplayName

Human-readable display name for the Data Stream.

Required for web data streams. The max allowed display name length is 255 UTF-16 code units.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Time when this stream was originally created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time when this stream was originally created.

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

getUpdateTime

Output only. Time when stream payload fields were last updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Time when stream payload fields were last updated.

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

getStreamData

Returns
TypeDescription
string