Class protos.google.analytics.data.v1alpha.FilterExpression (4.5.0)

Represents a FilterExpression.

Package

@google-analytics/data

Constructors

(constructor)(properties)

constructor(properties?: google.analytics.data.v1alpha.IFilterExpression);

Constructs a new FilterExpression.

Parameter
Name Description
properties IFilterExpression

Properties to set

Properties

andGroup

public andGroup?: (google.analytics.data.v1alpha.IFilterExpressionList|null);

FilterExpression andGroup.

expr

public expr?: ("andGroup"|"orGroup"|"notExpression"|"filter");

FilterExpression expr.

filter

public filter?: (google.analytics.data.v1alpha.IFilter|null);

FilterExpression filter.

notExpression

public notExpression?: (google.analytics.data.v1alpha.IFilterExpression|null);

FilterExpression notExpression.

orGroup

public orGroup?: (google.analytics.data.v1alpha.IFilterExpressionList|null);

FilterExpression orGroup.

Methods

create(properties)

public static create(properties?: google.analytics.data.v1alpha.IFilterExpression): google.analytics.data.v1alpha.FilterExpression;

Creates a new FilterExpression instance using the specified properties.

Parameter
Name Description
properties IFilterExpression

Properties to set

Returns
Type Description
FilterExpression

FilterExpression instance

decode(reader, length)

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

Decodes a FilterExpression 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
FilterExpression

FilterExpression

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
FilterExpression

FilterExpression

encode(message, writer)

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

Encodes the specified FilterExpression message. Does not implicitly messages.

Parameters
Name Description
message IFilterExpression

FilterExpression 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.data.v1alpha.IFilterExpression, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IFilterExpression

FilterExpression 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.data.v1alpha.FilterExpression;

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

FilterExpression

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for FilterExpression

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message FilterExpression

FilterExpression

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