Class protos.google.analytics.admin.v1alpha.UpdateDataRetentionSettingsRequest (4.5.1)

Represents an UpdateDataRetentionSettingsRequest.

Package

@google-analytics/admin

Constructors

(constructor)(properties)

constructor(properties?: google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest);

Constructs a new UpdateDataRetentionSettingsRequest.

Parameter
NameDescription
properties google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest

Properties to set

Properties

dataRetentionSettings

public dataRetentionSettings?: (google.analytics.admin.v1alpha.IDataRetentionSettings|null);

UpdateDataRetentionSettingsRequest dataRetentionSettings.

updateMask

public updateMask?: (google.protobuf.IFieldMask|null);

UpdateDataRetentionSettingsRequest updateMask.

Methods

create(properties)

public static create(properties?: google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest): google.analytics.admin.v1alpha.UpdateDataRetentionSettingsRequest;

Creates a new UpdateDataRetentionSettingsRequest instance using the specified properties.

Parameter
NameDescription
properties google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest

Properties to set

Returns
TypeDescription
google.analytics.admin.v1alpha.UpdateDataRetentionSettingsRequest

UpdateDataRetentionSettingsRequest instance

decode(reader, length)

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

Decodes an UpdateDataRetentionSettingsRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.analytics.admin.v1alpha.UpdateDataRetentionSettingsRequest

UpdateDataRetentionSettingsRequest

decodeDelimited(reader)

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

Decodes an UpdateDataRetentionSettingsRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.analytics.admin.v1alpha.UpdateDataRetentionSettingsRequest

UpdateDataRetentionSettingsRequest

encode(message, writer)

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

Encodes the specified UpdateDataRetentionSettingsRequest message. Does not implicitly messages.

Parameters
NameDescription
message google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest

UpdateDataRetentionSettingsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message google.analytics.admin.v1alpha.IUpdateDataRetentionSettingsRequest

UpdateDataRetentionSettingsRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.analytics.admin.v1alpha.UpdateDataRetentionSettingsRequest;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.analytics.admin.v1alpha.UpdateDataRetentionSettingsRequest

UpdateDataRetentionSettingsRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for UpdateDataRetentionSettingsRequest

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this UpdateDataRetentionSettingsRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.analytics.admin.v1alpha.UpdateDataRetentionSettingsRequest

UpdateDataRetentionSettingsRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an UpdateDataRetentionSettingsRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not