Class protos.google.analytics.admin.v1alpha.ExpandedDataSetFilter (7.3.0)

Represents an ExpandedDataSetFilter.

Package

@google-analytics/admin

Constructors

(constructor)(properties)

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

Constructs a new ExpandedDataSetFilter.

Parameter
Name Description
properties IExpandedDataSetFilter

Properties to set

Properties

fieldName

public fieldName: string;

ExpandedDataSetFilter fieldName.

inListFilter

public inListFilter?: (google.analytics.admin.v1alpha.ExpandedDataSetFilter.IInListFilter|null);

ExpandedDataSetFilter inListFilter.

oneFilter

public oneFilter?: ("stringFilter"|"inListFilter");

ExpandedDataSetFilter oneFilter.

stringFilter

public stringFilter?: (google.analytics.admin.v1alpha.ExpandedDataSetFilter.IStringFilter|null);

ExpandedDataSetFilter stringFilter.

Methods

create(properties)

public static create(properties?: google.analytics.admin.v1alpha.IExpandedDataSetFilter): google.analytics.admin.v1alpha.ExpandedDataSetFilter;

Creates a new ExpandedDataSetFilter instance using the specified properties.

Parameter
Name Description
properties IExpandedDataSetFilter

Properties to set

Returns
Type Description
ExpandedDataSetFilter

ExpandedDataSetFilter instance

decode(reader, length)

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

Decodes an ExpandedDataSetFilter 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
ExpandedDataSetFilter

ExpandedDataSetFilter

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ExpandedDataSetFilter

ExpandedDataSetFilter

encode(message, writer)

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

Encodes the specified ExpandedDataSetFilter message. Does not implicitly messages.

Parameters
Name Description
message IExpandedDataSetFilter

ExpandedDataSetFilter 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.v1alpha.IExpandedDataSetFilter, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IExpandedDataSetFilter

ExpandedDataSetFilter 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.v1alpha.ExpandedDataSetFilter;

Creates an ExpandedDataSetFilter 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
ExpandedDataSetFilter

ExpandedDataSetFilter

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ExpandedDataSetFilter

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ExpandedDataSetFilter

ExpandedDataSetFilter

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 an ExpandedDataSetFilter 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