Class protos.google.analytics.admin.v1beta.DataRetentionSettings (4.5.1)

Represents a DataRetentionSettings.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.analytics.admin.v1beta.IDataRetentionSettings);

Constructs a new DataRetentionSettings.

Parameter

Name	Description
`properties`	`IDataRetentionSettings` Properties to set

Properties

eventDataRetention

public eventDataRetention: (google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration|keyof typeof google.analytics.admin.v1beta.DataRetentionSettings.RetentionDuration);

DataRetentionSettings eventDataRetention.

name

public name: string;

DataRetentionSettings name.

resetUserDataOnNewActivity

public resetUserDataOnNewActivity: boolean;

DataRetentionSettings resetUserDataOnNewActivity.

Methods

create(properties)

public static create(properties?: google.analytics.admin.v1beta.IDataRetentionSettings): google.analytics.admin.v1beta.DataRetentionSettings;

Creates a new DataRetentionSettings instance using the specified properties.

Parameter

Name	Description
`properties`	`IDataRetentionSettings` Properties to set

Returns

Type	Description
`google.analytics.admin.v1beta.DataRetentionSettings`	DataRetentionSettings instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.analytics.admin.v1beta.DataRetentionSettings;

Decodes a DataRetentionSettings 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.DataRetentionSettings`	DataRetentionSettings

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.analytics.admin.v1beta.DataRetentionSettings;

Decodes a DataRetentionSettings 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.DataRetentionSettings`	DataRetentionSettings

encode(message, writer)

public static encode(message: google.analytics.admin.v1beta.IDataRetentionSettings, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified DataRetentionSettings message. Does not implicitly messages.

Parameters

Name	Description
`message`	`IDataRetentionSettings` DataRetentionSettings 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.IDataRetentionSettings, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
`message`	`IDataRetentionSettings` DataRetentionSettings 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.DataRetentionSettings;

Creates a DataRetentionSettings 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.DataRetentionSettings`	DataRetentionSettings

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for DataRetentionSettings

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 DataRetentionSettings to JSON.

Returns

Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.analytics.admin.v1beta.DataRetentionSettings, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
`message`	`google.analytics.admin.v1beta.DataRetentionSettings` DataRetentionSettings
`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 DataRetentionSettings message.

Parameter

Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not