Google Analytics Admin V1beta Client - Class DataStream (0.17.0)

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

A resource message representing a data stream.

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

Namespace

Google \ Analytics \ Admin \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ web_stream_data`	`Google\Analytics\Admin\V1beta\DataStream\WebStreamData` Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.
`↳ android_app_stream_data`	`Google\Analytics\Admin\V1beta\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\V1beta\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
Type	Description
`Google\Analytics\Admin\V1beta\DataStream\WebStreamData\|null`

hasWebStreamData

setWebStreamData

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

Parameter
Name	Description
`var`	`Google\Analytics\Admin\V1beta\DataStream\WebStreamData`

Returns
Type	Description
`$this`

getAndroidAppStreamData

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

Returns
Type	Description
`Google\Analytics\Admin\V1beta\DataStream\AndroidAppStreamData\|null`

hasAndroidAppStreamData

setAndroidAppStreamData

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

Parameter
Name	Description
`var`	`Google\Analytics\Admin\V1beta\DataStream\AndroidAppStreamData`

Returns
Type	Description
`$this`

getIosAppStreamData

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

Returns
Type	Description
`Google\Analytics\Admin\V1beta\DataStream\IosAppStreamData\|null`

hasIosAppStreamData

setIosAppStreamData

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

Parameter
Name	Description
`var`	`Google\Analytics\Admin\V1beta\DataStream\IosAppStreamData`

Returns
Type	Description
`$this`

getName

Output only. Resource name of this Data Stream.

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

Returns
Type	Description
`string`

setName

Output only. Resource name of this Data Stream.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getType

Required. Immutable. The type of this DataStream resource.

Returns
Type	Description
`int`

setType

Required. Immutable. The type of this DataStream resource.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Time when this stream was originally created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time when this stream was originally created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

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

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getStreamData

Returns
Type	Description
`string`