DataStream

google.analytics.admin.v1alpha. DataStream

Represents a DataStream.

Constructor

new DataStream(propertiesopt)

Constructs a new DataStream.

Parameters:
Name Type Attributes Description
properties google.analytics.admin.v1alpha.IDataStream <optional>

Properties to set

Implements:
  • IDataStream

Classes

AndroidAppStreamData
IosAppStreamData
WebStreamData

Members

DataStreamType

DataStreamType enum.

Properties:
Name Type Description
DATA_STREAM_TYPE_UNSPECIFIED number

DATA_STREAM_TYPE_UNSPECIFIED value

WEB_DATA_STREAM number

WEB_DATA_STREAM value

ANDROID_APP_DATA_STREAM number

ANDROID_APP_DATA_STREAM value

IOS_APP_DATA_STREAM number

IOS_APP_DATA_STREAM value

androidAppStreamData

DataStream androidAppStreamData.

createTime

DataStream createTime.

displayName

DataStream displayName.

iosAppStreamData

DataStream iosAppStreamData.

name

DataStream name.

streamData

DataStream streamData.

type

DataStream type.

updateTime

DataStream updateTime.

webStreamData

DataStream webStreamData.

Methods

(static) create(propertiesopt) → {google.analytics.admin.v1alpha.DataStream}

Creates a new DataStream instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.analytics.admin.v1alpha.IDataStream <optional>

Properties to set

Returns:
Type Description
google.analytics.admin.v1alpha.DataStream

DataStream instance

(static) decode(reader, lengthopt) → {google.analytics.admin.v1alpha.DataStream}

Decodes a DataStream message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.analytics.admin.v1alpha.DataStream

DataStream

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.analytics.admin.v1alpha.DataStream}

Decodes a DataStream message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.analytics.admin.v1alpha.DataStream

DataStream

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified DataStream message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.analytics.admin.v1alpha.IDataStream

DataStream message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified DataStream message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.analytics.admin.v1alpha.IDataStream

DataStream message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.analytics.admin.v1alpha.DataStream}

Creates a DataStream message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.analytics.admin.v1alpha.DataStream

DataStream

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from a DataStream message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.analytics.admin.v1alpha.DataStream

DataStream

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a DataStream message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this DataStream to JSON.

Returns:
Type Description
Object.<string, *>

JSON object