Filter

google.analytics.data.v1alpha. Filter

Represents a Filter.

Constructor

new Filter(propertiesopt)

Constructs a new Filter.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1alpha.IFilter <optional>

Properties to set

Implements:
  • IFilter

Classes

BetweenFilter
InListFilter
NumericFilter
StringFilter

Members

betweenFilter

Filter betweenFilter.

fieldName

Filter fieldName.

inListFilter

Filter inListFilter.

nullFilter

Filter nullFilter.

numericFilter

Filter numericFilter.

oneFilter

Filter oneFilter.

stringFilter

Filter stringFilter.

Methods

(static) create(propertiesopt) → {google.analytics.data.v1alpha.Filter}

Creates a new Filter instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.analytics.data.v1alpha.IFilter <optional>

Properties to set

Returns:
Type Description
google.analytics.data.v1alpha.Filter

Filter instance

(static) decode(reader, lengthopt) → {google.analytics.data.v1alpha.Filter}

Decodes a Filter message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.analytics.data.v1alpha.Filter

Filter

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.analytics.data.v1alpha.Filter}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.analytics.data.v1alpha.Filter

Filter

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Filter message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.IFilter

Filter message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.IFilter

Filter message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.analytics.data.v1alpha.Filter}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.analytics.data.v1alpha.Filter

Filter

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.analytics.data.v1alpha.Filter

Filter

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a Filter message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this Filter to JSON.

Returns:
Type Description
Object.<string, *>

JSON object