Represents a DataStream.
Package
@google-analytics/adminConstructors
(constructor)(properties)
constructor(properties?: google.analytics.admin.v1beta.IDataStream);Constructs a new DataStream.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataStream
Properties to set |
Properties
androidAppStreamData
public androidAppStreamData?: (google.analytics.admin.v1beta.DataStream.IAndroidAppStreamData|null);DataStream androidAppStreamData.
createTime
public createTime?: (google.protobuf.ITimestamp|null);DataStream createTime.
displayName
public displayName: string;DataStream displayName.
iosAppStreamData
public iosAppStreamData?: (google.analytics.admin.v1beta.DataStream.IIosAppStreamData|null);DataStream iosAppStreamData.
name
public name: string;DataStream name.
streamData
public streamData?: ("webStreamData"|"androidAppStreamData"|"iosAppStreamData");DataStream streamData.
type
public type: (google.analytics.admin.v1beta.DataStream.DataStreamType|keyof typeof google.analytics.admin.v1beta.DataStream.DataStreamType);DataStream type.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);DataStream updateTime.
webStreamData
public webStreamData?: (google.analytics.admin.v1beta.DataStream.IWebStreamData|null);DataStream webStreamData.
Methods
create(properties)
public static create(properties?: google.analytics.admin.v1beta.IDataStream): google.analytics.admin.v1beta.DataStream;Creates a new DataStream instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IDataStream
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.analytics.admin.v1beta.DataStream | DataStream instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.admin.v1beta.DataStream;Decodes a DataStream message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
google.analytics.admin.v1beta.DataStream | DataStream |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.admin.v1beta.DataStream;Decodes a DataStream message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
google.analytics.admin.v1beta.DataStream | DataStream |
encode(message, writer)
public static encode(message: google.analytics.admin.v1beta.IDataStream, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DataStream message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataStream
DataStream message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.analytics.admin.v1beta.IDataStream, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified DataStream message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IDataStream
DataStream message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.analytics.admin.v1beta.DataStream;Creates a DataStream message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
google.analytics.admin.v1beta.DataStream | DataStream |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for DataStream
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this DataStream to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.analytics.admin.v1beta.DataStream, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a DataStream message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.analytics.admin.v1beta.DataStream
DataStream |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a DataStream message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|