Class protos.google.analytics.admin.v1beta.PropertySummary (7.3.0)

Represents a PropertySummary.

Package

@google-analytics/admin

Constructors

(constructor)(properties)

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

Constructs a new PropertySummary.

Parameter
Name Description
properties IPropertySummary

Properties to set

Properties

displayName

public displayName: string;

PropertySummary displayName.

parent

public parent: string;

PropertySummary parent.

property

public property: string;

PropertySummary property.

propertyType

public propertyType: (google.analytics.admin.v1beta.PropertyType|keyof typeof google.analytics.admin.v1beta.PropertyType);

PropertySummary propertyType.

Methods

create(properties)

public static create(properties?: google.analytics.admin.v1beta.IPropertySummary): google.analytics.admin.v1beta.PropertySummary;

Creates a new PropertySummary instance using the specified properties.

Parameter
Name Description
properties IPropertySummary

Properties to set

Returns
Type Description
PropertySummary

PropertySummary instance

decode(reader, length)

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

Decodes a PropertySummary message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
PropertySummary

PropertySummary

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PropertySummary

PropertySummary

encode(message, writer)

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

Encodes the specified PropertySummary message. Does not implicitly messages.

Parameters
Name Description
message IPropertySummary

PropertySummary 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.IPropertySummary, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IPropertySummary

PropertySummary 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.PropertySummary;

Creates a PropertySummary 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
PropertySummary

PropertySummary

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PropertySummary

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message PropertySummary

PropertySummary

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 PropertySummary 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